Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Approve Rule action to also do updates #2153

Draft
wants to merge 2 commits into
base: develop
Choose a base branch
from
Draft

Update Approve Rule action to also do updates #2153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4c24482
Update Approve Rule action to also do updates
WilcoFiers Dec 20, 2023
beb64b2
Merge branch 'develop' into rule-update-action
carlosapaduarte Feb 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 70 additions & 30 deletions .github/scripts/approve-rule.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ import {
createOrCheckoutBranch,
commitAndPush
} from './commons.mjs';
import { getRulePages } from 'act-tools/dist/utils/get-page-data.js';
import { extractTestCases } from "act-tools/dist//build-examples/extract-test-cases.js";

const w3cDataFormat = 'D MMMM YYYY';
const isoDateFormat = 'YYYY-MM-DD';
Expand All @@ -22,11 +24,25 @@ if (!argv['skip-clone']) {
}

await createOrCheckoutBranch(config, argv.branch);
await archiveRule(config, argv.ruleId);
await generateApprovedRulePages(config, argv.ruleId);
await updateRuleVersionsYaml(config, argv.ruleId);
await updateRuleVersionsYaml(config, argv.ruleId, argv.changes);
await approveTestCaseJson(config, argv.ruleId);
await commitAndPush(config, `Set ${argv.ruleId} to approved`);

async function archiveRule({ tmpDir }, ruleId) {
const ruleDir = `${tmpDir}content/rules/${ruleId}`;
if (!fs.existsSync(`${ruleDir}/index.md`)) {
return;
}
const ruleText = fs.readFileSync(`${ruleDir}/index.md`, 'utf8');
const lastModified = ruleText.match(/last_modified:\s+(.*)/)?.[1]
assert(lastModified, `Unable to find last_modified data in ${ruleId}/index.md`);

const date = moment(lastModified, w3cDataFormat).format(isoDateFormat)
await $`mv ${ruleDir}/index.md ${ruleDir}/${date}.md`
Copy link
Member Author

@WilcoFiers WilcoFiers Jan 2, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO: This needs to be modified too: permalink, ref, & github.path need to be updated.
See: w3c/wcag-act-rules#264

}

async function generateApprovedRulePages({ tmpDir, rulesDir, glossaryDir, testAssetsDir }, ruleId) {
await $`node ./node_modules/act-tools/dist/cli/rule-transform.js \
--rulesDir "${rulesDir}" \
Expand All @@ -37,47 +53,71 @@ async function generateApprovedRulePages({ tmpDir, rulesDir, glossaryDir, testAs
`;
}

async function updateRuleVersionsYaml({ tmpDir }, ruleId) {
async function updateRuleVersionsYaml({ tmpDir }, ruleId, changes) {
if (typeof changes === 'string' && changes.length > 0) {
changes = [changes]
} else if (Array.isArray(changes)) {
changes = changes.filter(change => change.length > 0)
} else {
changes = []
}

const ruleVersionPath = `${tmpDir}_data/wcag-act-rules/rule-versions.yml`;
let ruleVersionsStr = fs.readFileSync(ruleVersionPath, 'utf8');
const ruleVersions = YAML.parse(ruleVersionsStr);
assert(
ruleVersions[ruleId] === undefined,
`RuleID ${ruleId} should not exists in rule-versions.yml. Was this rule approved before?`
);

const proposedText = fs.readFileSync(`${tmpDir}content/rules/${ruleId}/proposed.md`, 'utf8');
const proposedData = proposedText.match(/last_modified:\s+(.*)/)?.[1]
assert(proposedData, `Unable to find last_modified data in ${ruleId}/proposed.md`);
if (ruleVersions[ruleId] === undefined) {
const proposedText = fs.readFileSync(`${tmpDir}content/rules/${ruleId}/proposed.md`, 'utf8');
const proposedData = proposedText.match(/last_modified:\s+(.*)/)?.[1]
assert(proposedData, `Unable to find last_modified data in ${ruleId}/proposed.md`);

ruleVersions[ruleId] = [{
file: 'proposed.md',
url: `${ruleId}/proposed/`,
w3cDate: proposedData,
isoDate: moment(proposedData, w3cDataFormat).format(isoDateFormat)
}, {
file: 'index.md',
url: `${ruleId}/`,
w3cDate: moment().format(w3cDataFormat),
isoDate: moment().format(isoDateFormat)
}]
ruleVersions[ruleId] = [{
file: 'proposed.md',
url: `${ruleId}/proposed/`,
w3cDate: proposedData,
isoDate: moment(proposedData, w3cDataFormat).format(isoDateFormat)
}, {
file: 'index.md',
url: `${ruleId}/`,
w3cDate: moment().format(w3cDataFormat),
isoDate: moment().format(isoDateFormat)
}]
} else {
ruleVersions[ruleId].forEach(entry => {
if (entry.file === 'index.md') {
entry.file = entry.isoDate + '.md';
entry.url = `${ruleId}/${entry.isoDate}/`;
}
})
// Insert the new index after 'proposed.md'
ruleVersions[ruleId].splice(1, 0, {
file: 'index.md',
url: `${ruleId}/`,
w3cDate: moment().format(w3cDataFormat),
isoDate: moment().format(isoDateFormat),
changes
});
}

ruleVersionsStr = YAML.stringify(ruleVersions);
fs.writeFileSync(ruleVersionPath, ruleVersionsStr, 'utf8');
console.log(`Added ${ruleId} to rule-versions.yml`);
}

async function approveTestCaseJson({ tmpDir }, ruleId) {
let testCaseCount = 0;
async function approveTestCaseJson({ tmpDir, rulesDir, testAssetsDir }, ruleId) {
const rulePages = getRulePages(rulesDir, testAssetsDir, [ruleId]);
const ruleTestCases = extractTestCases(rulePages[0]).map(({ metadata }) => {
metadata.approved = true;
return metadata;
})

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) {
// Override rather than update so that `approved` isn't at the bottom
testCaseJson.testcases[index] = { ruleId, approved: true, ...testCase }
testCaseCount++
}
});
console.log(`Set ${testCaseCount} test cases of rule ${ruleId} to be approved in testcases.json`);
const testCases = testCaseJson.testcases.filter(testCase => testCase.ruleId !== ruleId);
testCaseJson.testcases = [
...ruleTestCases,
...testCases
]
console.log(`Set ${testCases.length} test cases of rule ${ruleId} to be approved in testcases.json`);
fs.writeFileSync(testCaseJsonPath, JSON.stringify(testCaseJson, null, 2), 'utf8');
}
25 changes: 24 additions & 1 deletion .github/workflows/approve-rule.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,21 @@ on:
branch:
description: 'Target branch name (new or existing)'
required: true
change1:
description: 'Change 1 (only for updating approved rules)'
required: false
change2:
description: 'Change 2 (leave blank if not needed)'
required: false
change3:
description: 'Change 3'
required: false
change4:
description: 'Change 3'
required: false
change5:
description: 'Change 3'
required: false

jobs:
dispatch:
Expand Down Expand Up @@ -38,4 +53,12 @@ jobs:
git config --global user.name "${{ secrets.WAI_GIT_NAME }}"
git config --global user.email "${{ secrets.WAI_GIT_EMAIL }}"
- name: Set rule to approved
run: npx zx .github/scripts/approve-rule.mjs --ruleId "${{ github.event.inputs.ruleId }}" --branch "${{ github.event.inputs.branch }}"
run: |
npx zx .github/scripts/approve-rule.mjs \
--ruleId "${{ github.event.inputs.ruleId }}" \
--branch "${{ github.event.inputs.branch }}" \
--changes "${{ github.event.inputs.change1 }}" \
--changes "${{ github.event.inputs.change2 }}" \
--changes "${{ github.event.inputs.change3 }}" \
--changes "${{ github.event.inputs.change4 }}" \
--changes "${{ github.event.inputs.change5 }}"
Loading