Merge branch 'rule-2ee8b8-may-2023' of https://github.com/dan-tripp-siteimprove/act-rules.github.io into rule-2ee8b8-may-2023

Author: dan-tripp-siteimprove

.github/ISSUE_TEMPLATE/ACCESSIBILITY_SUPPORT.md

@@ -14,19 +14,19 @@ assignees: ''
 
 - ... List the rules here, link to its acc support section
 
-## Test cases
+## Examples
 
-### Test case 1 ...
+### Example 1 ...
 
-(( Add test case here ))
+(( Add example here ))
 
 ```html
 code snippet here
 ```
 
-[Open this test case]()
+[Open this example]()
 
-(( Add a link to a code pen or other hosted test case. Keep in mind this test case needs to be accessible and persistent. ))
+(( Add a link to a code pen or other hosted example. Keep in mind this example needs to be accessible and persistent. ))
 
 #### Preconditions
 
@@ -39,12 +39,12 @@ Before running the test, check your settings. In many cases default settings are
 
 #### Test instructions
 
-(( Provide instructions on how to test the test case, this should include: ))
+(( Provide instructions on how to test the example, this should include: ))
 
 - Which technologies to use
 - Any setting changes necessary to run the test
 - Any variation in how to operate the different assistive technologies
-- Step by step instructions on how to check the test case
+- Step by step instructions on how to check the example
 - What the expected results are
 
 ### External links

.github/PULL_REQUEST_TEMPLATE.md

@@ -9,8 +9,8 @@ Need for Call for Review:
 << check [Process Document on Call for Review](https://act-rules.github.io/pages/design/process/#call-for-review) >>
 This can be merged with 1 approval << choose reason: editorial changes to website/test code, adding new contributor, other (explain). >>
 This will not require a Call for Review << choose reason(s): editorial changes (including to the applicability, expectation or examples section), changes to assumptions, background, accessibility support, change to website/test code (not rule), other (explain). >>
-This will require a 1 week Call for Review << small changes affecting a small number of test cases, if in doubt do not use this. >>
-This will require a 2 weeks Call for Review << new rule, or substantial changes affecting a large number of test cases, if in doubt, use this. >>
+This will require a 1 week Call for Review << small changes affecting a small number of examples, if in doubt do not use this. >>
+This will require a 2 weeks Call for Review << new rule, or substantial changes affecting a large number of examples, if in doubt, use this. >>
 
 ---
 

.github/scripts/approve-rule.mjs

@@ -24,7 +24,7 @@ if (!argv['skip-clone']) {
 await createOrCheckoutBranch(config, argv.branch);
 await generateApprovedRulePages(config, argv.ruleId);
 await updateRuleVersionsYaml(config, argv.ruleId);
-await approveTestCaseJson(config, argv.ruleId);
+await approveexampleJson(config, argv.ruleId);
 await commitAndPush(config, `Set ${argv.ruleId} to approved`);
 
 async function generateApprovedRulePages({ tmpDir, rulesDir, glossaryDir, testAssetsDir }, ruleId) {
@@ -67,17 +67,17 @@ async function updateRuleVersionsYaml({ tmpDir }, ruleId) {
   console.log(`Added ${ruleId} to rule-versions.yml`);
 }
 
-async function approveTestCaseJson({ tmpDir }, ruleId) {
-  let testCaseCount = 0;
-  const testCaseJsonPath = `${tmpDir}content-assets/wcag-act-rules/testcases.json`;
-  const testCaseJson = JSON.parse(fs.readFileSync(testCaseJsonPath, 'utf8'));
-  testCaseJson.testcases.forEach((testCase, index) => {
-    if (testCase.ruleId === ruleId) {
+async function approveexampleJson({ tmpDir }, ruleId) {
+  let exampleCount = 0;
+  const exampleJsonPath = `${tmpDir}content-assets/wcag-act-rules/examples.json`;
+  const exampleJson = JSON.parse(fs.readFileSync(exampleJsonPath, 'utf8'));
+  exampleJson.examples.forEach((example, index) => {
+    if (example.ruleId === ruleId) {
       // Override rather than update so that `approved` isn't at the bottom
-      testCaseJson.testcases[index] = { ruleId, approved: true, ...testCase }
-      testCaseCount++
+      exampleJson.examples[index] = { ruleId, approved: true, ...example }
+      exampleCount++
     }
   });
-  console.log(`Set ${testCaseCount} test cases of rule ${ruleId} to be approved in testcases.json`);
-  fs.writeFileSync(testCaseJsonPath, JSON.stringify(testCaseJson, null, 2), 'utf8');
+  console.log(`Set ${exampleCount} examples of rule ${ruleId} to be approved in examples.json`);
+  fs.writeFileSync(exampleJsonPath, JSON.stringify(exampleJson, null, 2), 'utf8');
 }

.github/scripts/pr-preview.mjs

@@ -4,7 +4,7 @@ import { config, cloneWcagActRules, commitAndPush } from './commons.mjs'
 
 await cloneWcagActRules(config);
 await generateProposedRulePages(config);
-await generateTestCases(config);
+await generateexamples(config);
 // const commitMessage = (await $`git log -1 --pretty=%B`).stdout;
 // await commitAndPush(config, commitMessage);
 
@@ -18,7 +18,7 @@ async function generateProposedRulePages({ tmpDir, rulesDir, glossaryDir, testAs
   `;
 }
 
-async function generateTestCases({ tmpDir, rulesDir, testAssetsDir }) {
+async function generateexamples({ tmpDir, rulesDir, testAssetsDir }) {
   await $`node ./node_modules/act-tools/dist/cli/build-examples.js \
     --rulesDir "${rulesDir}" \
     --testAssetsDir "${testAssetsDir}" \

.github/scripts/wai-build.mjs

@@ -4,7 +4,7 @@ import { config, cloneWcagActRules, commitAndPush } from './commons.mjs'
 
 await cloneWcagActRules(config);
 await generateProposedRulePages(config);
-await generateTestCases(config);
+await generateexamples(config);
 const commitMessage = (await $`git log -1 --pretty=%B`).stdout;
 await commitAndPush(config, commitMessage);
 
@@ -18,7 +18,7 @@ async function generateProposedRulePages({ tmpDir, rulesDir, glossaryDir, testAs
   `;
 }
 
-async function generateTestCases({ tmpDir, rulesDir, testAssetsDir }) {
+async function generateexamples({ tmpDir, rulesDir, testAssetsDir }) {
   await $`node ./node_modules/act-tools/dist/cli/build-examples.js \
     --rulesDir "${rulesDir}" \
     --testAssetsDir "${testAssetsDir}" \

.github/workflows/approve-rule.yml

@@ -14,16 +14,16 @@ jobs:
   dispatch:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v6
       - name: Check user permission
         uses: 74th/workflow-permission-action@1.0.0
         with:
           listfile: .github/workflows/chair-accounts.md
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v6
         with:
-          node-version: '16'
+          node-version: '24'
           cache: npm
-      - uses: actions/cache@v3
+      - uses: actions/cache@v5
         with:
           path: ~/.npm
           key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}

.github/workflows/dispatch.yml

@@ -12,10 +12,10 @@ jobs:
   dispatch:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v6
+      - uses: actions/setup-node@v6
         with:
-          node-version: 16
+          node-version: 24
           cache: npm
       - run: |
           curl -XPOST -u "${{ secrets.USER_NAME }}:${{ secrets.USER_PAT }}" -H "Accept: application/vnd.github.everest-preview+json" -H "Content-Type: application/json" https://api.github.com/repos/act-rules/act-rules-web/dispatches --data '{ "event_type": "build_application" }'

.github/workflows/publish.yml

@@ -11,12 +11,12 @@ jobs:
   publish:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v6
         with:
           ref: 'master'
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v6
         with:
-          node-version: 16
+          node-version: 24
           cache: npm
       - run: |
           git config user.name "${{ secrets.USER_NAME }}"

.github/workflows/test.yml

@@ -16,10 +16,10 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v6
+      - uses: actions/setup-node@v6
         with:
-          node-version: 16
+          node-version: 24
           cache: npm
       - run: |
           npm install

.github/workflows/wai-deploy.yml

@@ -9,12 +9,12 @@ jobs:
   dispatch:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v6
+      - uses: actions/setup-node@v6
         with:
-          node-version: '16'
+          node-version: '24'
           cache: npm
-      - uses: actions/cache@v3
+      - uses: actions/cache@v5
         with:
           path: ~/.npm
           key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
@@ -23,6 +23,9 @@ jobs:
       - run: git config --global url."https://github.com/".insteadOf ssh://git@github.com/
       - name: Install dependencies
         run: npm ci
+      # Since we control this we can safely just always use the latest
+      - name: Install act-tools latest
+        run: npm install github:act-rules/act-tools#main
       - name: Configure git
         run: |
           git config --global url."https://${{ secrets.WAI_GIT_NAME }}:${{ secrets.WAI_GIT_ACCESS_TOKEN }}@github.com".insteadOf "https://github.com"