Merge branch 'semi-rewrite' of https://github.com/StephenDev0/StikDebug into semi-rewrite

Author: StephenDev0

.github/workflows/build_ipa.yml

@@ -1,32 +1,32 @@
-name: Build Unsigned Debug IPA
+name: Build Debug IPA
 
 on:
   push:
-    branches: [ "main" ]
+    branches: [ "main", "semi-rewrite" ]
   pull_request:
-    branches: [ "main" ]
+    branches: [ "main", "semi-rewrite" ]
   workflow_dispatch:
 
 permissions:
   contents: write  
 
 jobs:
-  build:
-    name: Build Debug IPA
+  build_and_release:
+    name: Build & Release IPA
     runs-on: macos-latest  
     env:
       UPLOAD_IPA: ${{ vars.UPLOAD_IPA || 'true' }}
 
     steps:
-      - name: Checkout
+      - name: 1. Fetch Source Code
         uses: actions/checkout@v4
 
-      - name: Setup Xcode (latest stable)
+      - name: 2. Configure Xcode Environment
         uses: maxim-lobanov/setup-xcode@v1
         with:
           xcode-version: '26.0.1' 
 
-      - name: Archive Build (Debug, Unsigned)
+      - name: 3. Compile Project Archive
         run: |
           xcodebuild clean archive \
             -project StikDebug.xcodeproj \
@@ -42,36 +42,39 @@ jobs:
             SWIFT_OPTIMIZATION_LEVEL="-Onone" \
             IPHONEOS_DEPLOYMENT_TARGET=17.4
 
-      - name: Create IPA from Archive
+      - name: 4. Package .app into .ipa
         run: |
           cp -R build/StikDebug.xcarchive/Products/Applications/StikDebug.app .
           mkdir -p Payload
           cp -R StikDebug.app Payload/
           zip -r StikDebug.ipa Payload
           rm -rf Payload StikDebug.app
 
-      - name: Upload Debug IPA (artifact)
+      - name: 5. Store IPA as Workflow Artifact
         if: env.UPLOAD_IPA == 'true'
         uses: actions/upload-artifact@v4
         with:
           name: StikDebug-Debug.ipa
           path: StikDebug.ipa
           retention-days: 90
 
-      - name: Read app version
+      - name: 6. Extract Version Information
         id: version
         run: |
           VERSION=$(sed -n 's/.*MARKETING_VERSION = \(.*\);/\1/p' StikDebug.xcodeproj/project.pbxproj | head -1 | xargs)
           echo "app_version=$VERSION" >> "$GITHUB_OUTPUT"
 
-      - name: Create or Update GitHub Release (Nightly)
-        if: env.UPLOAD_IPA == 'true' && github.event_name == 'push' && github.ref == 'refs/heads/main'
+      - name: 7. Deploy to Nightly Release
+        if: |
+          env.UPLOAD_IPA == 'true' && 
+          (github.event_name == 'push' || github.event_name == 'workflow_dispatch') && 
+          (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/semi-rewrite')
         uses: softprops/action-gh-release@v2
         with:
-          tag_name: Nightly
-          name: "Nightly - v${{ steps.version.outputs.app_version }}"
+          tag_name: "Nightly-v${{ steps.version.outputs.app_version }}"
+          name: "Nightly Build - v${{ steps.version.outputs.app_version }}"
           prerelease: true
-          generate_release_notes: false
+          generate_release_notes: true
           target_commitish: ${{ github.sha }}
           files: |
             StikDebug.ipa

README.md

@@ -57,15 +57,15 @@
 | 17.4 – 18.x              | Fully supported      | Stable                                                                |
 | 26.0 – 26.3              | Supported            | Limited App Availability (Developers need to update their apps to work.)                                        |
 | 26.4 Developer Beta 1    | Critical issues   | lockdownd drops connections → JIT broken; do not update               |
-| iOS 26.4+ betas / future | Untested / partial   | Check Discord, releases, or [@StephenDev0 on X](https://x.com/stephendev0) for updates                                 |
+| iOS 26.4+ betas / future | Untested / partial   | Check [Discord](https://discord.gg/ZnNcrRT3M8), [releases](https://github.com/StephenDev0/StikDebug/releases), or [@StephenDev0 on X](https://x.com/stephendev0) for updates                                 |
 
 ## How to Enable JIT
 
 StikDebug enables **JIT** for sideloaded apps on iOS 17.4+ without needing a computer after the initial pairing setup.
 
 ### Requirements
 - StikDebug installed (via AltSource, direct .ipa, or self-built)
-- A valid **pairing file** (.mobiledevicepairing / lockdown pair) for your device
+- A valid **pairing file** (.plist / .mobiledevicepairing) for your device
 - SideStore / AltStore / similar sideload tool (for app refreshing)
 - A loopback vpn such as [LocalDevVPN](https://apps.apple.com/us/app/localdevvpn/id6755608044)
 
@@ -151,7 +151,7 @@ To propose a new feature, open a feature request issue and provide:
 - The problem it solves or the use case it addresses
 - Any relevant examples or implementation ideas
 
-### Code Contributions
+### Code Contributions (Best Practices)
 - Follow normal Swift and SwiftUI style.
 - Write clear and easy to understand code.
 - Keep your changes consistent with how the project is already set up.