Refactor documentation update workflow to use peter-evans/create-pull-request action

Author: AlvaroRausell

.github/workflows/update-documentation.yml

@@ -22,36 +22,15 @@ jobs:
           generate-docs: "true"
           base-path-to-features: "./src"
 
-      - name: Create a PR for Documentation
-        id: push_image_info
-        env:
-          GITHUB_TOKEN: ${{ secrets.PAT }}
-        run: |
-          set -e
-          echo "Start."
-
-          # Configure git and Push updates
-          git config --global user.email [email protected]
-          git config --global user.name github-actions
-          git config pull.rebase false
-
-          branch=automated-documentation-update-$GITHUB_RUN_ID
-          git checkout -b $branch
-          message='Automated documentation update'
-
-          # Add / update and commit
-          git add */**/README.md
-          git commit -m 'Automated documentation update [skip ci]' || export NO_UPDATES=true
-
-          # Push
-          if [ "$NO_UPDATES" != "true" ] ; then
-              git push origin "$branch"
-              gh api \
-                --method POST \
-                -H "Accept: application/vnd.github+json" \
-                /repos/${GITHUB_REPOSITORY}/pulls \
-                -f title="$message" \
-              -f body="$message" \
-              -f head="$branch" \
-              -f base='main'
-          fi
+      - name: Create Pull Request for Documentation
+        uses: peter-evans/create-pull-request@v6
+        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