chore: did the same to the help sync script

Author: Kaspar Lyngsie

.github/workflows/sync-cli-help-to-user-docs.yml

@@ -1,43 +1,107 @@
-name: Synchronize Help
-
+name: Synchronize CLI Help to User Docs
 on:
   workflow_dispatch:
   schedule:
-    - cron: '0 9 * * 1' # Mon at 9
-  push:
-    branches: [chore/docs-action]
+    - cron: '0 9 * * 1' # Monday at 9
+
+env:
+  DESTINATION_BRANCH: docs/automatic-gitbook-update-cli-help
+  COMMIT_MESSAGE: "docs: synchronizing help from snyk/user-docs"
 
 jobs:
   build:
     name: synchronize-help
     runs-on: ubuntu-latest
     steps:
-      - run: |
-          gh auth setup-git
+      - name: Checkout user-docs repository
+        uses: actions/checkout@v4
+        with:
+          repository: snyk/user-docs
+          path: user-docs
+          ref: main
+
+      - name: Checkout cli repository
+        uses: actions/checkout@v4
+        with:
+          repository: snyk/cli
+          path: cli
+          token: ${{ secrets.GITHUB_TOKEN }}
+          fetch-depth: 0
+
+      - name: Configure git user
+        run: |
           git config --global user.email "noreply@snyk.io"
+          
+          # GITHUB_ACTOR: The name of the person or app that initiated the workflow.
           git config --global user.name "$GITHUB_ACTOR"
-          gh repo clone snyk/snyk cli -- --depth=1 --quiet
-          gh repo clone snyk/user-docs docs -- --depth=1 --quiet
-          git -C ./cli checkout -b docs/automatic-gitbook-update
 
+      - name: Create or checkout destination branch
+        run: |
+          cd cli
+          if git show-ref --verify --quiet refs/heads/${{ env.DESTINATION_BRANCH }}; then
+            echo "Branch ${{ env.DESTINATION_BRANCH }} already exists, checking out."
+            git checkout ${{ env.DESTINATION_BRANCH }}
+            exit 0
+          fi
+          
+          echo "Branch ${{ env.DESTINATION_BRANCH }} does not exist, creating and checking out."
+          git checkout -b ${{ env.DESTINATION_BRANCH }}
+
+      - name: Copy help documentation from user-docs to CLI
+        run: |
           cp ./docs/docs/snyk-cli/commands/*.md ./cli/help/cli-commands/
 
-          if [[ $(git -C ./cli status --porcelain) ]]; then
-            echo "Documentation changes detected"
-            cd ./cli
-            npm clean-install
-            npx prettier --write ./help/cli-commands/*.md
-            git --no-pager diff --name-only
-            git add .
-            git commit -m "docs: synchronizing help from snyk/user-docs"
-            git push --force --set-upstream origin docs/automatic-gitbook-update
-            if [[ ! $(gh pr view docs/automatic-gitbook-update 2>&1 | grep -q "no open pull requests";) ]]; then
-              echo "Creating PR"
-              gh pr create --title="docs: Synchronizing CLI help from user-docs" --body="Automatic PR controlled by GitHub Action" --head docs/automatic-gitbook-update
-            fi
-            echo "PR exists, pushed changes to it."
-          else
+      - name: Format help files with Prettier
+        run: |
+          cd ./cli
+          npm clean-install
+          npx prettier --write ./help/cli-commands/*.md
+
+      - name: Check for changes
+        id: check_changes
+        run: |
+          cd ./cli
+          if [[ -z "$(git status --porcelain)" ]]; then
             echo "No documentation changes detected, exiting."
+            echo "continue=false" >> "$GITHUB_OUTPUT"
+            exit 0
+          fi
+
+          echo "--- Documentation changes detected from GitBooks ---"
+          git --no-pager diff --name-only --color=always
+          echo "------------------------------------------------"
+          
+          echo "continue=true" >> "$GITHUB_OUTPUT"
+
+      - name: Commit and push changes (if any)
+        if: steps.check_changes.outputs.continue == 'true'
+        run: |
+          cd ./cli
+          git add .
+          git commit -m "${{ env.COMMIT_MESSAGE }}"
+          git push --force --set-upstream origin ${{ env.DESTINATION_BRANCH }}
+
+      - name: Create or update a pull request
+        if: steps.check_changes.outputs.continue == 'true'
+        run: |
+          cd ./cli
+          PR_NUMBER=$(gh pr list \
+            --head "${{ env.DESTINATION_BRANCH }}" \
+            --json number \
+            --jq '.[0].number' \
+            --limit 1)
+
+          if [ -n "$PR_NUMBER" ]; then
+            echo "PR #$PR_NUMBER already exists. Updating it."
+            echo "Pushed changes to existing PR #$PR_NUMBER."
+            exit 0
           fi
+          
+          echo "No existing PR found. Creating a new one."
+          gh pr create \
+            --title="${{ env.COMMIT_MESSAGE }}" \
+            --body="Automatic PR controlled by GitHub Action" \
+            --head "${{ env.DESTINATION_BRANCH }}" \
+            --base main
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}