Making reusable-regenerate-readme GitHub-y

.github/workflows/reusable-regenerate-readme.yml

@@ -9,10 +9,9 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 
-
 jobs:
 
-  regenerate-readme: #----------------------------------------------------------
+  regenerate-readme:
     name: Regenerate README.md file
     runs-on: ubuntu-latest
     if: ${{ github.repository_owner == 'wp-cli' && ! contains(fromJson('[".github", "wp-cli", "wp-cli-bundle", "wp-super-cache-cli", "php-cli-tools", "wp-config-transformer", "wp-cli.github.com"]'), github.event.repository.name) }}
@@ -21,51 +20,55 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Set up PHP envirnoment
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: '7.4'
         env:
           COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: "7.4"
 
       - name: Check existence of composer.json file
         id: check_composer_file
         uses: andstor/file-existence-action@v2
         with:
-          files: "composer.json"
+          files: composer.json
 
       - name: Install Composer dependencies & cache dependencies
-        if: steps.check_composer_file.outputs.files_exists == 'true'
-        uses: "ramsey/composer-install@v2"
+        if: ${{ steps.check_composer_file.outputs.files_exists == 'true' }}
         env:
           COMPOSER_ROOT_VERSION: dev-${{ github.event.repository.default_branch }}
+        uses: ramsey/composer-install@v2
         with:
           # Bust the cache at least once a month - output format: YYYY-MM.
-          custom-cache-suffix: $(date -u "+%Y-%m")
+          custom-cache-suffix: |
+            $(date --utc "+%Y-%m")
 
       - name: Configure git user
         run: |
           git config --global user.email "[email protected]"
           git config --global user.name "Alain Schlesser"
 
       - name: Check if remote branch exists
-        run: echo "REMOTE_BRANCH_EXISTS=$([[ -z $(git ls-remote --heads origin regenerate-readme) ]] && echo "0" || echo "1")" >> $GITHUB_ENV
-
+        id: check_remote_branch
+        run: >
+          echo "exists=$(git ls-remote --exit-code --heads origin regenerate-readme &>/dev/null
+            && echo "true" || echo "false")" >>"${GITHUB_OUTPUT}"
+
       - name: Create branch to base pull request on
-        if: env.REMOTE_BRANCH_EXISTS == 0
+        if: ${{ steps.check_remote_branch.outputs.exists == 'false' }}
         run: |
           git checkout -b regenerate-readme
 
       - name: Fetch existing branch to add commits to
-        if: env.REMOTE_BRANCH_EXISTS == 1
+        if: ${{ steps.check_remote_branch.outputs.exists == 'true' }}
         run: |
           git fetch --all --prune
           git checkout regenerate-readme
           git pull --no-rebase
 
-      - name: Install WP-CLI
+      - name: Install WP-CLI nightly
         run: |
           curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli-nightly.phar
-          sudo mv wp-cli-nightly.phar /usr/local/bin/wp
+          sudo mv --verbose wp-cli-nightly.phar /usr/local/bin/wp
           sudo chmod +x /usr/local/bin/wp
 
       - name: Regenerate README.md file
@@ -74,25 +77,31 @@ jobs:
           wp scaffold package-readme --branch=${{ github.event.repository.default_branch }} --force .
 
       - name: Check if there are changes
-        run: echo "CHANGES_DETECTED=$([[ -z $(git status --porcelain) ]] && echo "0" || echo "1")" >> $GITHUB_ENV
+        id: check_changes
+        run: >
+          echo "detected=$(test -n "$(git status --porcelain 2>/dev/null)"
+            && echo "true" || echo "false")" >>"${GITHUB_OUTPUT}"
 
       - name: Commit changes
-        if: env.CHANGES_DETECTED == 1
+        if: ${{ steps.check_changes.outputs.detected == 'true' }}
         run: |
           git add README.md
           git commit -m "Regenerate README file - $(date +'%Y-%m-%d')"
           git push origin regenerate-readme
 
       - name: Create pull request
-        if: |
-          env.CHANGES_DETECTED == 1 &&
-          env.REMOTE_BRANCH_EXISTS == 0
+        if: >
+          ${{ steps.check_changes.outputs.detected == 'true'
+            && steps.check_remote_branch.outputs.exists == 'false' }}
         uses: repo-sync/pull-request@v2
         with:
           source_branch: regenerate-readme
           destination_branch: ${{ github.event.repository.default_branch }}
           github_token: ${{ secrets.GITHUB_TOKEN }}
           pr_title: Regenerate README file
-          pr_body: "**This is an automated pull-request**\n\nRefreshes the `README.md` file with the latest changes to the docblocks in the source code."
+          pr_body: |
+            **This is an automated pull-request**
+
+            Refreshes the `README.md` file with the latest changes to the docblocks in the source code.
           pr_reviewer: schlessera
           pr_label: scope:documentation