Refactor documentation update workflow to separate token generation and PR creation steps

Author: AlvaroRausell

.github/workflows/update-documentation.yml

@@ -22,15 +22,51 @@ jobs:
           generate-docs: "true"
           base-path-to-features: "./src"
 
-      - name: Create Pull Request for Documentation
-        uses: peter-evans/create-pull-request@v6
+      - name: Generate GitHub App Token
+        id: generate_token
+        uses: tibdex/[email protected]
         with:
-          app-id: ${{ secrets.DEVCONTAINERS_APP_ID }}
-          private-key: ${{ secrets.DEVCONTAINERS_APP_CLIENT_SECRET }}
-          commit-message: Automated documentation update [skip ci]
-          title: Automated documentation update
-          body: |
-            Automated documentation update by the Devcontainers app.
-            This PR includes updates to README.md files generated by the workflow.
-          branch: automated-documentation-update-${{ github.run_id }}
-          base: main
+          app_id: ${{ secrets.DEVCONTAINERS_APP_ID }}
+          private_key: ${{ secrets.DEVCONTAINERS_APP_CLIENT_SECRET }}
+
+      - name: Commit and Create PR for Documentation
+        env:
+          GH_TOKEN: ${{ steps.generate_token.outputs.token }}
+        run: |
+          set -e
+          echo "Configuring Git..."
+          git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git config --global user.name "github-actions[bot]"
+          git config pull.rebase false
+
+          branch="automated-documentation-update-${{ github.run_id }}"
+          echo "Checking out new branch: $branch"
+          git checkout -b "$branch"
+
+          commit_message='Automated documentation update'
+          pr_title='Automated documentation update'
+          pr_body='Automated documentation update by the Devcontainers app.\\nThis PR includes updates to README.md files generated by the workflow.'
+
+          echo "Adding updated README.md files..."
+          # Assuming READMEs are updated within the src directory structure
+          git add src/**/README.md
+
+          echo "Checking for changes..."
+          if git diff --staged --quiet; then
+            echo "No changes to commit. Exiting."
+            exit 0
+          fi
+
+          echo "Committing changes..."
+          git commit -m "$commit_message [skip ci]"
+
+          echo "Pushing changes to origin/$branch..."
+          git push origin "$branch"
+
+          echo "Creating pull request..."
+          gh pr create \\
+            --title "$pr_title" \\
+            --body "$pr_body" \\
+            --head "$branch" \\
+            --base "main"
+          echo "Pull request created successfully."