Merge pull request #297 from humanmade/build-ci

Refresh CI job and introduce Release action/branch

Author: mattheu

.github/workflows/build.yml

@@ -0,0 +1,21 @@
+name: Build to "release" branch
+
+on:
+  push:
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref_name }}
+  cancel-in-progress: true
+
+jobs:
+  release:
+    name: "Update release branch"
+    uses: humanmade/hm-github-actions/.github/workflows/build-and-release-node.yml@a9a243d6c42fbff4a967d7ce0a6b307bc77251b7 # v0.1.0
+    with:
+      # Default build action `npm run build` is sufficient.
+      node_version: 20
+      source_branch: main
+      release_branch: release
+      built_asset_paths: dist

.github/workflows/ci.yml

@@ -11,6 +11,16 @@ on:
       - opened
       - ready_for_review
       - synchronize
+    # Only run on a given PR if relevant files have changed.
+    paths:
+      - '.eslintignore'
+      - '.eslintrc.js'
+      - '.npmrc'
+      - '**.js'
+      - '**.json'
+      - '**.jsx'
+      - 'babel.config.js'
+      - 'webpack.config.js'
 
 defaults:
   run:
@@ -22,62 +32,5 @@ concurrency:
 
 jobs:
   node:
-    name: Node
-    runs-on: ubuntu-22.04
-
-    strategy:
-      matrix:
-        node-version: [ 16 ]
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-
-      - name: Paths filters
-        uses: dorny/paths-filter@v2
-        id: paths
-        with:
-          filters: |
-            workflows: &workflows
-              - '.github/actions/**/*.yml'
-              - '.github/workflows/**/*.yml'
-            npm: &npm
-              - *workflows
-              - 'package.json'
-              - 'package-lock.json'
-            javascript: &javascript
-              - *workflows
-              - '**/*.js'
-            eslint:
-              - *workflows
-              - *javascript
-              - *npm
-              - '**/*.json'
-              - '.eslintignore'
-              - '.eslintrc'
-
-      - name: Setup
-        if: ${{ toJSON( steps.paths.outputs.changes ) != '"[]"' }}
-        uses: ./.github/actions/setup-node
-        with:
-          cache_version: ${{ secrets.GH_ACTIONS_CACHE_KEY }}
-
-      - name: Install dependencies
-        if: ${{ toJSON( steps.paths.outputs.changes ) != '"[]"' && steps.cache-node-dependencies.outputs.cache-hit != 'true' }}
-        run: npm ci --no-progress --no-fund --no-audit --loglevel error
-
-      - name: Lint code
-        if: ${{ steps.paths.outputs.eslint == 'true' }}
-        uses: wearerequired/lint-action@v2
-        with:
-          continue_on_error: false
-          eslint: true
-          eslint_extensions: js,json
-
-      - name: Run tests
-        if: ${{ steps.paths.outputs.javascript == 'true' || steps.paths.outputs.npm == 'true' }}
-        run: npm test
-
-      - name: Build application
-        if: ${{ steps.paths.outputs.javascript == 'true' || steps.paths.outputs.npm == 'true' }}
-        run: npm run build
+    uses: ./.github/workflows/node.yml
+    secrets: inherit

.github/workflows/node.yml

@@ -0,0 +1,71 @@
+name: Node
+
+on: workflow_call
+
+jobs:
+  node:
+    name: Node
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [ 20 ]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      - name: Paths filters
+        uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36 # v3.0.2
+        id: paths
+        with:
+          filters: |
+            workflows: &workflows
+              - '.github/actions/**/*.yml'
+              - '.github/workflows/**/*.yml'
+            npm: &npm
+              - *workflows
+              - 'package.json'
+              - 'package-lock.json'
+            javascript: &javascript
+              - *workflows
+              - '**/*.js'
+            eslint:
+              - *workflows
+              - *javascript
+              - *npm
+              - '**/*.json'
+              - '.eslintignore'
+              - '.eslintrc.js'
+
+      - name: Set up Node
+        if: ${{ toJSON( steps.paths.outputs.changes ) != '"[]"' }}
+        uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+
+      - name: Install dependencies
+        if: ${{ toJSON( steps.paths.outputs.changes ) != '"[]"' && steps.cache-node-dependencies.outputs.cache-hit != 'true' }}
+        run: npm ci --progress=false --audit=false --fund=false
+
+      - name: Lint code and save linting report JSON
+        if: ${{ steps.paths.outputs.eslint == 'true' }}
+        run: npm run lint -- --output-file eslint_report.json --format json
+        # Continue to the next step even if this fails, so we can report on it.
+        continue-on-error: true
+
+      - name: Annotate Code Linting Results
+        uses: ataylorme/eslint-annotate-action@d57a1193d4c59cbfbf3f86c271f42612f9dbd9e9 # v3.0.0
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          report-json: 'eslint_report.json'
+          only-pr-files: true
+
+      - name: Run tests
+        if: ${{ steps.paths.outputs.javascript == 'true' || steps.paths.outputs.npm == 'true' }}
+        run: npm test
+
+      - name: Build application
+        if: ${{ steps.paths.outputs.javascript == 'true' || steps.paths.outputs.npm == 'true' }}
+        run: npm run build

.nvmrc

@@ -1 +1 @@
-v18.18.0
+v20

package-lock.json

@@ -39,7 +39,7 @@
 		"eslint-config-react-app": "^7.0.1",
 		"eslint-plugin-flowtype": "^8.0.3",
 		"eslint-plugin-import": "^2.27.5",
-		"eslint-plugin-jsdoc": "^39.3.23",
+		"eslint-plugin-jsdoc": "^45.0.0",
 		"eslint-plugin-jsonc": "^2.7.0",
 		"eslint-plugin-jsx-a11y": "^6.7.1",
 		"eslint-plugin-react": "^7.32.2",