Build: Add scripts for commit and nightly information

This automatically embeds the commit hash and if the build is an
actions nightly or not which will help with debugging crashes.

Signed-off-by: kingbri <bdashore3@proton.me>

.github/workflows/nightly.yml

@@ -14,18 +14,19 @@ jobs:
         with:
           xcode-version: latest
       - name: Get commit SHA
-        id: commitinfo
+        run: echo "sha_short=$(git rev-parse --short HEAD)" >> $GITHUB_ENV
-        run: echo "::set-output name=sha_short::$(git rev-parse --short HEAD)"
       - name: Build
         run: xcodebuild -scheme Ferrite -configuration Release archive -archivePath build/Ferrite.xcarchive CODE_SIGN_IDENTITY= CODE_SIGNING_REQUIRED=NO CODE_SIGNING_ALLOWED=NO
+        env:
+          IS_NIGHTLY: YES
       - name: Package ipa
         run: |
           mkdir Payload
           cp -r build/Ferrite.xcarchive/Products/Applications/Ferrite.app Payload
-          zip -r Ferrite-iOS_nightly-${{ steps.commitinfo.outputs.sha_short }}.ipa Payload
+          zip -r Ferrite-iOS_nightly-${{ env.sha_short }}.ipa Payload
       - name: Upload artifacts
         uses: actions/upload-artifact@v2
         with:
-          name: Ferrite-iOS_nightly-${{ steps.commitinfo.outputs.sha_short }}.ipa
+          name: Ferrite-iOS_nightly-${{ env.sha_short }}.ipa
-          path: Ferrite-iOS_nightly-${{ steps.commitinfo.outputs.sha_short }}.ipa
+          path: Ferrite-iOS_nightly-${{ env.sha_short }}.ipa
           if-no-files-found: error

Ferrite.xcodeproj/project.pbxproj

@@ -26,6 +26,7 @@
 		0C422E80293542F300486D65 /* PremiumizeModels.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0C422E7F293542F300486D65 /* PremiumizeModels.swift */; };
 		0C42B5962932F2D5008057A0 /* DebridChoiceView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0C42B5952932F2D5008057A0 /* DebridChoiceView.swift */; };
 		0C42B5982932F6DD008057A0 /* Set.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0C42B5972932F6DD008057A0 /* Set.swift */; };
+		0C445C62293F9A0B0060744D /* Bundle.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0C445C61293F9A0B0060744D /* Bundle.swift */; };
 		0C44E2A828D4DDDC007711AE /* Application.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0C44E2A728D4DDDC007711AE /* Application.swift */; };
 		0C44E2AD28D51C63007711AE /* BackupManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0C44E2AC28D51C63007711AE /* BackupManager.swift */; };
 		0C44E2AF28D52E8A007711AE /* BackupsView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0C44E2AE28D52E8A007711AE /* BackupsView.swift */; };
@@ -133,6 +134,7 @@
 		0C422E7F293542F300486D65 /* PremiumizeModels.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PremiumizeModels.swift; sourceTree = "<group>"; };
 		0C42B5952932F2D5008057A0 /* DebridChoiceView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DebridChoiceView.swift; sourceTree = "<group>"; };
 		0C42B5972932F6DD008057A0 /* Set.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Set.swift; sourceTree = "<group>"; };
+		0C445C61293F9A0B0060744D /* Bundle.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Bundle.swift; sourceTree = "<group>"; };
 		0C44E2A728D4DDDC007711AE /* Application.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Application.swift; sourceTree = "<group>"; };
 		0C44E2AC28D51C63007711AE /* BackupManager.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BackupManager.swift; sourceTree = "<group>"; };
 		0C44E2AE28D52E8A007711AE /* BackupsView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BackupsView.swift; sourceTree = "<group>"; };
@@ -410,6 +412,8 @@
 		0CA148C8288903F000DE2211 /* Extensions */ = {
 			isa = PBXGroup;
 			children = (
+				0CD72E16293D9928001A7EA4 /* Array.swift */,
+				0C445C61293F9A0B0060744D /* Bundle.swift */,
 				0CA148C9288903F000DE2211 /* Collection.swift */,
 				0CA148CA288903F000DE2211 /* Data.swift */,
 				0CA429F728C5098D000D0610 /* DateFormatter.swift */,
@@ -420,7 +424,6 @@
 				0C7ED14228D65518009E29AD /* FileManager.swift */,
 				0C42B5972932F6DD008057A0 /* Set.swift */,
 				0C7C128528DAA3CD00381CD1 /* URL.swift */,
-				0CD72E16293D9928001A7EA4 /* Array.swift */,
 			);
 			path = Extensions;
 			sourceTree = "<group>";
@@ -523,6 +526,7 @@
 				0CAF1C64286F5C0E00296F86 /* Sources */,
 				0CAF1C65286F5C0E00296F86 /* Frameworks */,
 				0CAF1C66286F5C0E00296F86 /* Resources */,
+				0C445C60293F99360060744D /* Insert environment vars into Plist */,
 			);
 			buildRules = (
 			);
@@ -599,6 +603,29 @@
 		};
 /* End PBXResourcesBuildPhase section */
 
+/* Begin PBXShellScriptBuildPhase section */
+		0C445C60293F99360060744D /* Insert environment vars into Plist */ = {
+			isa = PBXShellScriptBuildPhase;
+			alwaysOutOfDate = 1;
+			buildActionMask = 2147483647;
+			files = (
+			);
+			inputFileListPaths = (
+			);
+			inputPaths = (
+				$BUILT_PRODUCTS_DIR/$INFOPLIST_PATH,
+			);
+			name = "Insert environment vars into Plist";
+			outputFileListPaths = (
+			);
+			outputPaths = (
+			);
+			runOnlyForDeploymentPostprocessing = 0;
+			shellPath = /bin/sh;
+			shellScript = "# Type a script or drag a script file from your workspace to insert its path.\n# From https://stackoverflow.com/questions/26514866/how-can-i-include-the-git-commit-hash-in-xcode\n\nINFO_PLIST=\"${TARGET_BUILD_DIR}\"/\"${INFOPLIST_PATH}\"\n\n# MARK: Adds commit hash to plist\ncommitValue=$(/usr/libexec/PlistBuddy -c 'print :GitCommitHash' \"${INFO_PLIST}\" 2>/dev/null)\n\n# Check if value is empty\nif [ -z \"$commitValue\" ] \nthen\n   /usr/libexec/PlistBuddy -c \"Add :GitCommitHash string\" \"${INFO_PLIST}\"\nfi\n\n/usr/libexec/PlistBuddy -c \"Set :GitCommitHash `git rev-parse --short HEAD`\" \"${INFO_PLIST}\"\n\n# MARK: Adds the git build type to plist (examples: nightly, stable)\nbuildTypeValue=$(/usr/libexec/PlistBuddy -c 'print :IsNightly' \"${INFO_PLIST}\" 2>/dev/null)\n\n# Check if value is empty\nif [ -z \"$buildTypeValue\" ] \nthen\n   /usr/libexec/PlistBuddy -c \"Add :IsNightly bool\" \"${INFO_PLIST}\"\nfi\n\n/usr/libexec/PlistBuddy -c \"Set :IsNightly ${IS_NIGHTLY}\" \"${INFO_PLIST}\"\n";
+		};
+/* End PBXShellScriptBuildPhase section */
+
 /* Begin PBXSourcesBuildPhase section */
 		0CAF1C64286F5C0E00296F86 /* Sources */ = {
 			isa = PBXSourcesBuildPhase;
@@ -647,6 +674,7 @@
 				0CD4CAC628C980EB0046E1DC /* HistoryActionsView.swift in Sources */,
 				0C422E7E293542EA00486D65 /* PremiumizeWrapper.swift in Sources */,
 				0CA148DD288903F000DE2211 /* ScrapingViewModel.swift in Sources */,
+				0C445C62293F9A0B0060744D /* Bundle.swift in Sources */,
 				0C0755C6293424A200ECA142 /* DebridLabelView.swift in Sources */,
 				0CB6516A28C5B4A600DCA721 /* InlineHeader.swift in Sources */,
 				0CA148D8288903F000DE2211 /* MagnetChoiceView.swift in Sources */,

Ferrite/Classes/Application.swift

@@ -20,11 +20,16 @@ public class Application {
         Bundle.main.object(forInfoDictionaryKey: "CFBundleVersion") as? String ?? "0"
     }
 
+    // Debug = development, Nightly = actions, Release = stable
     var buildType: String {
         #if DEBUG
         return "Debug"
         #else
-        return "Release"
+        if Bundle.main.isNightly {
+            return "Nightly"
+        } else {
+            return "Release"
+        }
         #endif
     }
 }

Ferrite/Extensions/Bundle.swift

@@ -0,0 +1,18 @@
+//
+//  Bundle.swift
+//  Ferrite
+//
+//  Created by Brian Dashore on 12/6/22.
+//
+
+import Foundation
+
+extension Bundle {
+    var commitHash: String? {
+        infoDictionary?["GitCommitHash"] as? String
+    }
+
+    var isNightly: Bool {
+        infoDictionary?["IsNightly"] as? Bool ?? false
+    }
+}

Ferrite/Views/AboutView.swift

@@ -14,6 +14,11 @@ struct AboutView: View {
                 ListRowTextView(leftText: "Version", rightText: Application.shared.appVersion)
                 ListRowTextView(leftText: "Build number", rightText: Application.shared.appBuild)
                 ListRowTextView(leftText: "Build type", rightText: Application.shared.buildType)
+
+                if let commitHash = Bundle.main.commitHash {
+                    ListRowTextView(leftText: "Commit", rightText: commitHash)
+                }
+
                 ListRowLinkView(text: "Discord server", link: "https://discord.gg/sYQxnuD7Fj")
                 ListRowLinkView(text: "GitHub repository", link: "https://github.com/bdashore3/Ferrite")
             } header: {