Merge pull request #954 from dequelabs/release

Release v4.8.2

.eslintrc.js

@@ -39,6 +39,7 @@ module.exports = {
     {
       files: ['*.test.ts', '*.test.tsx', '*.spec.ts', '*.spec.tsx'],
       rules: {
+        '@typescript-eslint/no-empty-function': 'off',
         '@typescript-eslint/no-explicit-any': 'off',
         '@typescript-eslint/no-non-null-assertion': 'off'
       }

.github/dependabot.yml

@@ -0,0 +1,42 @@
+version: 2
+
+updates:
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'monthly'
+    open-pull-requests-limit: 10
+    commit-message:
+      prefix: 'chore'
+    groups:
+      # Any updates not caught by the group config will get individual PRs
+      gha-low-risk:
+        update-types:
+          - 'minor'
+          - 'patch'
+
+  - package-ecosystem: 'npm'
+    directory: '/'
+    schedule:
+      interval: 'monthly'
+    open-pull-requests-limit: 10
+    commit-message:
+      prefix: 'chore'
+    ignore:
+      # Handled separately by its own workflow
+      - dependency-name: '@axe-core/*'
+      - dependency-name: 'axe-core'
+      # Prevent updates to ESM-only versions
+      - dependency-name: 'execa'
+        versions: ['>=6.0.0']
+      - dependency-name: 'node-fetch'
+        versions: ['>=3.0.0']
+      # Breaking change due to node version requirements
+      - dependency-name: 'commander'
+        versions: ['>=10.0.0']
+    groups:
+      # Any updates not caught by the group config will get individual PRs
+      npm-low-risk:
+        update-types:
+          - 'minor'
+          - 'patch'

.github/workflows/auto-patch-release.yml

@@ -5,6 +5,7 @@ jobs:
   create_patch_release:
     name: Create release
     runs-on: ubuntu-latest
+    timeout-minutes: 3
     steps:
       - name: Determine if we skip cancel checks
         id: skip-checks

.github/workflows/create-release-candidate.yml

@@ -0,0 +1,24 @@
+name: Create release candidate 
+
+on:
+  workflow_dispatch:
+    inputs:
+      version-locked:
+        type: boolean
+        description: Prevent this action from creating a minor or major release
+        default: true
+
+jobs:
+  create-release-candidate:
+    timeout-minutes: 2
+    runs-on: ubuntu-latest
+    steps:
+      - uses: dequelabs/axe-api-team-public/.github/actions/create-release-candidate-v1@main
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          base: 'master'
+          head: 'develop'
+          release-script-path: './.github/scripts/prepare_release.sh'
+          version-locked: ${{ inputs.version-locked }}
+        env:
+          GH_TOKEN: ${{ secrets.GH_PROJECT_TOKEN }}

.github/workflows/create-release.yml

@@ -12,9 +12,10 @@ jobs:
   create_release:
     name: Create release
     runs-on: ubuntu-latest
+    timeout-minutes: 3
     steps:
       - name: Checkout repo
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           fetch-depth: 0
@@ -44,7 +45,7 @@ jobs:
           git checkout master
           git reset --hard "$commitHash"
       - name: Create pull request
-        uses: peter-evans/create-pull-request@v3
+        uses: peter-evans/create-pull-request@153407881ec5c347639a548ade7d8ad1d6740e38 # tag=v5
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           branch: release

.github/workflows/deploy.yml

@@ -4,15 +4,17 @@ on:
   push:
     branches:
       - develop
+      - release
       - master
 
 jobs:
   canary:
     runs-on: ubuntu-latest
+    timeout-minutes: 10
     if: github.ref_name == 'develop' && github.repository_owner == 'dequelabs'
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
           node-version: 18
           cache: 'npm'
@@ -34,12 +36,39 @@ jobs:
             --force-publish \
             --yes
 
+  relase-candidate:
+    runs-on: ubuntu-latest
+    if: github.ref_name == 'release' && github.repository_owner == 'dequelabs'
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: 'npm'
+      - run: npm ci
+      # Ensure packages are built
+      - run: npm run build
+      # Make sure the working tree is clean
+      - run: git reset --hard HEAD
+      - run: npm config set "//registry.npmjs.org/:_authToken" ${{ secrets.NPM_TOKEN }}
+      - run: |
+          npx lerna publish prepatch \
+            --no-verify-access \
+            --no-git-tag-version \
+            --no-push \
+            --canary \
+            --dist-tag=rc \
+            --exact \
+            --preid=$(git rev-parse --short HEAD) \
+            --force-publish \
+            --yes
+
   production:
     runs-on: ubuntu-latest
     if: github.ref_name == 'master' && github.repository_owner == 'dequelabs'
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
           node-version: 18
           cache: 'npm'
@@ -53,4 +82,10 @@ jobs:
           npx lerna publish from-package \
             --force-publish='*' \
             --yes
-      - uses: softprops/action-gh-release@de2c0eb89ae2a093876385947365aca7b0e5f844 # v0.1.15
+      - run: |
+          PKG_VERSION=$(jq -r .version < lerna.json)
+          gh release create $PKG_VERSION \
+            --title "Release $PKG_VERSION" \
+            --generate-notes \
+            --repo ${{ github.repository }}
+            --target master

.github/workflows/semantic-pr-footer.yml

@@ -0,0 +1,15 @@
+name: Semantic PR footer
+
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - edited
+      - synchronize
+
+jobs:
+  semantic-pr-footer:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: dequelabs/axe-api-team-public/.github/actions/semantic-pr-footer-v1@main

.github/workflows/semantic-pr-title.yml

@@ -10,6 +10,7 @@ on:
 
 jobs:
   semantic-pr-title:
+    timeout-minutes: 1
     runs-on: ubuntu-latest
     steps:
       - uses: dequelabs/semantic-pr-title@v1

.github/workflows/sync-master-develop.yml

@@ -8,6 +8,7 @@ on:
 jobs:
   create_sync_pull_request:
     runs-on: ubuntu-latest
+    timeout-minutes: 2
     steps:
       - uses: dequelabs/action-sync-branches@v1
         with: