chore: updated tutorial workflow so it makes a PR instead of pushing to main

Author: darrenmelvison1

.github/scripts/process-passport-tutorials.sh

@@ -12,16 +12,14 @@ TUTORIALS_DIR="${PASSPORT_ROOT}/_tutorials~"
 
 echo "Processing Passport tutorials..."
 
-# Load features.json to get feature groups
 FEATURES_JSON="${PASSPORT_ROOT}/features.json"
 if [ ! -f "${FEATURES_JSON}" ]; then
   echo "Error: features.json not found at ${FEATURES_JSON}"
   exit 1
 fi
 
-# Create _tutorials directory in docs repo
-DOCS_TUTORIALS_DIR="${DOCS_REPO_DIR}/docs/main/example/zkEVM/unity/passport-examples/_tutorials"
-mkdir -p "${DOCS_TUTORIALS_DIR}"
+# Base directory for usage guides in the docs repo
+DOCS_USAGE_GUIDES_DIR="${DOCS_REPO_DIR}/docs/main/build/unity/usage-guides"
 
 # Check if _tutorials~ directory exists
 if [ ! -d "${TUTORIALS_DIR}" ]; then
@@ -40,12 +38,16 @@ else
     if [ -f "${TUTORIAL_FILE}" ]; then
       echo "Found tutorial for ${GROUP_NAME}"
 
+      # Define the destination directory for this feature group
+      DEST_GROUP_DIR="${DOCS_USAGE_GUIDES_DIR}/${GROUP_NAME}"
+      mkdir -p "${DEST_GROUP_DIR}"
+      
       # Use the folder name directly for the destination filename
       OUTPUT_FILENAME="${GROUP_NAME}.md"
 
-      # Copy the tutorial file
-      cp "${TUTORIAL_FILE}" "${DOCS_TUTORIALS_DIR}/${OUTPUT_FILENAME}"
-      echo "Copied ${TUTORIAL_FILE} to ${DOCS_TUTORIALS_DIR}/${OUTPUT_FILENAME}"
+      # Copy the tutorial file to its new group directory
+      cp "${TUTORIAL_FILE}" "${DEST_GROUP_DIR}/${OUTPUT_FILENAME}"
+      echo "Copied ${TUTORIAL_FILE} to ${DEST_GROUP_DIR}/${OUTPUT_FILENAME}"
     else
       echo "Warning: No tutorial.md found for feature group ${GROUP_NAME}"
     fi

.github/workflows/publish-passport-tutorials.yml

@@ -37,7 +37,7 @@ jobs:
           repository: immutable/docs
           token: ${{ secrets.UNITY_SDK_DOCS_WORKFLOW }}
           path: imx-docs
-          ref: 'main'
+          ref: 'DVR-295-docs-restructure'
 
       - name: Setup environment variables
         run: echo "CLONE_DIR=./imx-docs" >> $GITHUB_ENV
@@ -65,20 +65,32 @@ jobs:
           .github/scripts/process-passport-tutorials.sh
         shell: bash
 
-      - name: Commit and Push Changes to Docs Repo
+      - name: Create Pull Request in Docs Repo
+        id: create_pr
         run: |
           cd "$CLONE_DIR"
-          if git status --porcelain | grep -q .; then
-            git add .
-            
-            # Commit with reference to source commit
-            COMMIT_MSG="docs: Update Passport tutorials from Unity SDK (Ref: ${GITHUB_SHA::8})"
-            git commit -m "$COMMIT_MSG"
-            
-            # Push to the target branch
-            git push -u origin main
-            echo "Successfully pushed Passport tutorial changes to docs repo"
-          else
+          if ! git status --porcelain | grep -q .; then
             echo "No changes to commit"
+            echo "pr_url=" >> $GITHUB_OUTPUT
+            exit 0
           fi
+
+          BRANCH_NAME="chore/sdk-docs-update-${{ github.run_id }}"
+          git checkout -b $BRANCH_NAME
+          
+          git add .
+          git commit -m "Update example app tutorials from SDK repo"
+          git push -u origin $BRANCH_NAME
+          echo "Successfully pushed changes to docs repo on branch $BRANCH_NAME"
+
+          PR_URL=$(gh pr create \
+            --title "Update example app tutorials from SDK repo" \
+            --body "Automated PR from unity-immutable-sdk to update tutorials. Review and merge if all looks good." \
+            --base DVR-295-docs-restructure \
+            --repo immutable/docs)
+          
+          echo "Successfully created PR in docs repo: $PR_URL"
+          echo "pr_url=${PR_URL}" >> $GITHUB_OUTPUT
+        env:
+          GITHUB_TOKEN: ${{ secrets.UNITY_SDK_DOCS_WORKFLOW }}
         shell: bash