CI: add GitHub Actions workflow linter (#594)

emmercm · Aug 23, 2023 · 8b97a41 · 8b97a41
1 parent c4e1abf
commit 8b97a41
Show file tree

Hide file tree

Showing 6 changed files with 64 additions and 25 deletions.
diff --git a/.github/workflows/compile.yml b/.github/workflows/compile.yml
@@ -26,7 +26,7 @@ jobs:
               NPM_PKG_VERSION=$(npm pkg get version | sed 's/"//g')
               NODE_ARCH=amd64
               BIN_OUTPUT="igir-${NPM_PKG_VERSION}-${RUNNER_OS}-${NODE_ARCH/\//}.tar.gz"
-              echo "BIN_OUTPUT=${BIN_OUTPUT}" >> $GITHUB_ENV
+              echo "BIN_OUTPUT=${BIN_OUTPUT}" >> "${GITHUB_ENV}"
               cp package.json build/
               docker run --rm --platform "linux/${NODE_ARCH}" --volume "$(pwd):/app" --workdir "/app" \
                 "node:$(cat .nvmrc)" sh -c \
@@ -37,7 +37,7 @@ jobs:
               NPM_PKG_VERSION=$(npm pkg get version | sed 's/"//g')
               NODE_ARCH=arm/v7
               BIN_OUTPUT="igir-${NPM_PKG_VERSION}-${RUNNER_OS}-${NODE_ARCH/\//}.tar.gz"
-              echo "BIN_OUTPUT=${BIN_OUTPUT}" >> $GITHUB_ENV
+              echo "BIN_OUTPUT=${BIN_OUTPUT}" >> "${GITHUB_ENV}"
               cp package.json build/
               docker run --rm --platform "linux/${NODE_ARCH}" --volume "$(pwd):/app" --workdir "/app" \
                 "node:$(cat .nvmrc)" sh -c \
@@ -48,7 +48,7 @@ jobs:
               NPM_PKG_VERSION=$(npm pkg get version | sed 's/"//g')
               NODE_ARCH=arm64/v8
               BIN_OUTPUT="igir-${NPM_PKG_VERSION}-${RUNNER_OS}-${NODE_ARCH/\//}.tar.gz"
-              echo "BIN_OUTPUT=${BIN_OUTPUT}" >> $GITHUB_ENV
+              echo "BIN_OUTPUT=${BIN_OUTPUT}" >> "${GITHUB_ENV}"
               cp package.json build/
               docker run --rm --platform "linux/${NODE_ARCH}" --volume "$(pwd):/app" --workdir "/app" \
                 "node:$(cat .nvmrc)" sh -c \
@@ -59,7 +59,7 @@ jobs:
               NPM_PKG_VERSION=$(npm pkg get version | sed 's/"//g')
               NODE_ARCH=$(node --print 'process.arch')
               BIN_OUTPUT="igir-${NPM_PKG_VERSION}-${RUNNER_OS}-${NODE_ARCH}.tar.gz"
-              echo "BIN_OUTPUT=${BIN_OUTPUT}" >> $GITHUB_ENV
+              echo "BIN_OUTPUT=${BIN_OUTPUT}" >> "${GITHUB_ENV}"
               cp package.json build/
               ./node_modules/.bin/caxa --input build/ --output igir -- "{{caxa}}/node_modules/.bin/node" "{{caxa}}/index.js"
               ./igir --help
@@ -108,7 +108,7 @@ jobs:
           node-version-file: '.nvmrc'
           cache: 'npm'
       - run: npm ci
-      - run: echo "NPM_PKG_VERSION=$(npm pkg get version | sed 's/"//g')" >> $GITHUB_ENV
+      - run: echo "NPM_PKG_VERSION=$(npm pkg get version | sed 's/"//g')" >> "${GITHUB_ENV}"
       # Download and update
       - uses: actions/download-artifact@v3
       - uses: softprops/action-gh-release@v1

diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml
@@ -18,7 +18,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - run: docker run -v $PWD:/workdir ghcr.io/igorshubovych/markdownlint-cli:latest --disable MD013 MD033 MD046 -- "**/*.md"
+      - run: docker run -v "${PWD}:/workdir" ghcr.io/igorshubovych/markdownlint-cli:latest --disable MD013 MD033 MD046 -- "**/*.md"
 
   build:
     if: github.event_name == 'pull_request'

diff --git a/.github/workflows/pr-renamer.yml b/.github/workflows/pr-renamer.yml
@@ -32,7 +32,7 @@ jobs:
           fi
 
           if [[ ! "${OLD_TITLE}" =~ ^[a-zA-Z\\(\\)\\!]+: ]]; then
-            echo "ERROR=No conventional commit type found. The allowed list is: ${ALLOWED_TYPES//|/, }" >> "$GITHUB_OUTPUT"
+            echo "ERROR=No conventional commit type found. The allowed list is: ${ALLOWED_TYPES//|/, }" >> "${GITHUB_OUTPUT}"
             exit 1
           fi
 
@@ -59,12 +59,12 @@ jobs:
 
           # Restrict types
           if [[ ! "${NEW_TITLE}" =~ ^${ALLOWED_TYPES}: ]]; then
-            echo "ERROR=The conventional commit type isn't in the allowed list: ${ALLOWED_TYPES//|/, }" >> "$GITHUB_OUTPUT"
+            echo "ERROR=The conventional commit type isn't in the allowed list: ${ALLOWED_TYPES//|/, }" >> "${GITHUB_OUTPUT}"
             exit 1
           fi
 
-          echo "OLD_TITLE=${OLD_TITLE}" >> "$GITHUB_OUTPUT"
-          echo "NEW_TITLE=${NEW_TITLE}" >> "$GITHUB_OUTPUT"
+          echo "OLD_TITLE=${OLD_TITLE}" >> "${GITHUB_OUTPUT}"
+          echo "NEW_TITLE=${NEW_TITLE}" >> "${GITHUB_OUTPUT}"
       # Required for `gh` CLI
       - uses: actions/checkout@v3
       - id: gh-pr-edit

diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml
@@ -56,11 +56,13 @@ jobs:
         id: auto-changelog
         run: |
           EOF=$(dd if=/dev/urandom bs=15 count=1 status=none | base64)
-          echo "MARKDOWN<<$EOF" >> "$GITHUB_OUTPUT"
-          ./scripts/auto-changelog.sh >> "$GITHUB_OUTPUT"
-          echo "" >> "$GITHUB_OUTPUT"
-          echo "" >> "$GITHUB_OUTPUT"
-          echo "$EOF" >> "$GITHUB_OUTPUT"
+          {
+            echo "MARKDOWN<<$EOF"
+            ./scripts/auto-changelog.sh
+            echo ""
+            echo ""
+            echo "$EOF"
+          } >> "$GITHUB_OUTPUT"
 
       # Create/update the draft release
       - if: steps.check.outputs.changed == 'true'
@@ -80,6 +82,8 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
       - if: ${{ steps.release-drafter.outputs.id }}
         run: |
-          echo "# v${{ steps.check.outputs.version }} @ ${{ env.ref }}" >> "$GITHUB_STEP_SUMMARY"
-          echo "" >> "$GITHUB_STEP_SUMMARY"
-          echo "${{ steps.release-drafter.outputs.html_url }}" >> "$GITHUB_STEP_SUMMARY"
+          {
+            echo "# v${{ steps.check.outputs.version }} @ ${{ env.ref }}"
+            echo ""
+            echo "${{ steps.release-drafter.outputs.html_url }}"
+          } >> "$GITHUB_STEP_SUMMARY"
diff --git a/.github/workflows/version-bump.yml b/.github/workflows/version-bump.yml
@@ -41,15 +41,15 @@ jobs:
           git add --all
 
           USER_EMAIL="${GITHUB_ACTOR_ID}+${GITHUB_ACTOR}@users.noreply.github.com"
-          echo "USER_EMAIL=${USER_EMAIL}" >> "$GITHUB_OUTPUT"
+          echo "USER_EMAIL=${USER_EMAIL}" >> "${GITHUB_OUTPUT}"
           git config --global user.email "${USER_EMAIL}"
 
-          USER_NAME="$(gh api /users/${GITHUB_ACTOR} | jq .name -r)"
-          echo "USER_NAME=${USER_NAME}" >> "$GITHUB_OUTPUT"
+          USER_NAME="$(gh api "/users/${GITHUB_ACTOR}" | jq .name -r)"
+          echo "USER_NAME=${USER_NAME}" >> "${GITHUB_OUTPUT}"
           git config --global user.name "${USER_NAME}"
 
           PACKAGE_VERSION="$(jq --raw-output '.version' package.json)"
-          echo "PACKAGE_VERSION=${PACKAGE_VERSION}" >> "$GITHUB_OUTPUT"
+          echo "PACKAGE_VERSION=${PACKAGE_VERSION}" >> "${GITHUB_OUTPUT}"
           git commit -m "v${PACKAGE_VERSION}"
         env:
           GH_TOKEN: ${{ github.token }}
@@ -69,9 +69,11 @@ jobs:
           reviewers: ${{ (!inputs.auto-merge && github.repository_owner != github.actor) && github.repository_owner || '' }}
       - if: ${{ steps.create-pull-request.outputs.pull-request-number }}
         run: |
-          echo "# v${{ steps.bump-and-commit.outputs.PACKAGE_VERSION }}" >> "$GITHUB_STEP_SUMMARY"
-          echo "" >> "$GITHUB_STEP_SUMMARY"
-          echo "${{ steps.create-pull-request.outputs.pull-request-url }}" >> "$GITHUB_STEP_SUMMARY"
+          {
+            echo "# v${{ steps.bump-and-commit.outputs.PACKAGE_VERSION }}"
+            echo ""
+            echo "${{ steps.create-pull-request.outputs.pull-request-url }}"
+          } >> "$GITHUB_STEP_SUMMARY"
       - if: ${{ steps.create-pull-request.outputs.pull-request-number && inputs.auto-merge }}
         run: gh pr merge "${{ steps.create-pull-request.outputs.pull-request-number }}" --squash --auto
         env:

diff --git a/.github/workflows/workflow-linter.yml b/.github/workflows/workflow-linter.yml
@@ -0,0 +1,33 @@
+name: Workflow Linter
+
+on:
+  pull_request:
+    types:
+      # - edited  # PR's base branch was changed
+      - opened
+      - reopened
+      - synchronize  # PR's branch was edited (i.e. new commits)
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v4
+      - run: go install github.com/rhysd/actionlint/cmd/actionlint@latest
+      - run: actionlint
+
+  # !!! This check should be required by GitHub !!!
+  workflow-status-check:
+    if: always()
+    needs:
+      - lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: re-actors/alls-green@release/v1
+        with:
+          jobs: ${{ toJSON(needs) }}