Skip to content

editorial: CI for roleInfo.js - #2625

Merged
pkra merged 9 commits into
mainfrom
2501-roleInfo-CI
Oct 14, 2025
Merged

editorial: CI for roleInfo.js#2625
pkra merged 9 commits into
mainfrom
2501-roleInfo-CI

Conversation

@pkra

@pkra pkra commented Sep 5, 2025

Copy link
Copy Markdown
Member

Adds github actions and scripts to enable automatic checking and updating of roleInfo.js

  • common/script/buildRoleInfo.js
  • roleInfo.yml: updates roleInfo.js on pushes to main
    • standard nodejs setup
    • installs linkedom and runs buildRoleInfo.js to update roleInfo
  • roleInfoCheck.yml: checks PRs if they introduce changes to roleInfo.js
    • similar to roleInfo.yml but only reports on git diff (no commit)

Part of #2501


Preview | Diff

@pkra

This comment was marked as outdated.

@pkra
pkra requested review from jnurthen and spectranaut September 5, 2025 10:10
@pkra

This comment was marked as outdated.

@spectranaut spectranaut left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Ok, well, as you say, this is pretty silly, but I'm fine with it as an intermediate step!

I looked at the code but not enough to try to think of suggesting anything differently. Let me know if you want me to think harder about it.

Edit: oh now I see maybe you want to answer these other questions before landing. I will come back to this and think about it.

@pkra pkra added this to ARIA Editors Sep 9, 2025
@github-project-automation github-project-automation Bot moved this to Agenda+ in ARIA Editors Sep 9, 2025
@pkra

pkra commented Sep 11, 2025

Copy link
Copy Markdown
Member Author

Discussed in yesterday's editors' call https://www.w3.org/2025/09/10-aria-editors-minutes.html#73b0

From there:

let's make it a PR action to do a diff.

@pkra pkra self-assigned this Sep 11, 2025
@pkra

pkra commented Sep 11, 2025

Copy link
Copy Markdown
Member Author

@spectranaut it occurs to me that running this on a PR to show a diff will never get us an update. Should it also silently run updates on main?

@pkra pkra mentioned this pull request Jul 10, 2025
28 tasks
@pkra
pkra force-pushed the 2501-roleInfo-aria1.3 branch from b29bb5e to 2f9ec60 Compare September 18, 2025 08:21
@pkra pkra moved this from Agenda+ to In Progress in ARIA Editors Sep 24, 2025
First working draft of a CI approach.
- common/script/buildRoleInfo.js
  - currently very hacky way of running aria.js using linkedom
- roleInfo.yml
  - standard nodejs setup
  - installs linkedom and runs buildRoleInfo.js to update roleInfo

Part of  #2501
As per editor's decision, this action fails when a PR creates changes in roleInfo.js;
it is meant to trigger review.
Prevents "nothing to commit" errors when there are no changes.
@pkra pkra changed the title editorial: CI to update roleInfo editorial: CI for roleInfo.js Sep 25, 2025
@pkra
pkra marked this pull request as ready for review September 25, 2025 10:19
@pkra
pkra changed the base branch from 2501-roleInfo-aria1.3 to main September 25, 2025 10:20
@netlify

netlify Bot commented Sep 25, 2025

Copy link
Copy Markdown

Deploy Preview for wai-aria ready!

Name Link
🔨 Latest commit 16819f9
🔍 Latest deploy log https://app.netlify.com/projects/wai-aria/deploys/68d51e6c1297ef00087e9866
😎 Deploy Preview https://deploy-preview-2625--wai-aria.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Runs prettier to match current output.
Uses npx to find prettier.
@pkra
pkra requested a review from spectranaut September 25, 2025 10:49
@pkra
pkra requested a review from daniel-montalvo October 2, 2025 06:34
@pkra pkra added editorial a change to an example, note, spelling, grammar, or is related to publishing or the repo spec:aria labels Oct 2, 2025
@pkra pkra moved this from In Progress to Agenda+ in ARIA Editors Oct 7, 2025
@pkra

pkra commented Oct 8, 2025

Copy link
Copy Markdown
Member Author

Discussed in the editors' call today https://www.w3.org/2025/10/08-aria-editors-minutes.html#fae4

@pkra

pkra commented Oct 9, 2025

Copy link
Copy Markdown
Member Author

@daniel-montalvo I looked into the question from yesterday's call. From what I've gathered, I think github actions will run into the same problem with forks that we tried to avoid - the action on the fork won't have write access to the PR thread. I think your idea would require a more complex solution (like the netlify tooling).

@pkra

pkra commented Oct 9, 2025

Copy link
Copy Markdown
Member Author

@daniel-montalvo if you agree, could we merge this and find a solution for surfacing the diff later? That way we can continue the work on aria.js

@daniel-montalvo

Copy link
Copy Markdown
Contributor

Sure, +1 to merging this as-is for now.

@pkra
pkra merged commit 04f4485 into main Oct 14, 2025
7 checks passed
@github-project-automation github-project-automation Bot moved this from Agenda+ to Done in ARIA Editors Oct 14, 2025
@pkra

pkra commented Oct 14, 2025

Copy link
Copy Markdown
Member Author

Well, that didn't work.

github-actions Bot added a commit that referenced this pull request Oct 14, 2025
SHA: 04f4485
Reason: push, by pkra

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@pkra

pkra commented Oct 14, 2025

Copy link
Copy Markdown
Member Author

@daniel-montalvo @spectranaut @jnurthen it turns out the idea to regenerate roleInfo on the main branch won't work because the branch is protected. Any ideas?

@pkra

pkra commented Oct 14, 2025

Copy link
Copy Markdown
Member Author

@daniel-montalvo I'll make a PR that matches prettier.yaml's checkout settings (since that obviously works).

daniel-montalvo pushed a commit that referenced this pull request Oct 15, 2025
Adds github actions and scripts to enable automatic checking and updating of roleInfo.js

- common/script/buildRoleInfo.js
  - currently very hacky way of running aria.js using linkedom (see #2501 for plans on removing hackery)
- roleInfo.yml: updates roleInfo.js on pushes to main
  - standard nodejs setup
  - installs linkedom and runs buildRoleInfo.js to update roleInfo
- roleInfoCheck.yml: checks PRs if they introduce changes to roleInfo.js
   - similar to roleInfo.yml but only reports on git diff (no commit)

Part of  #2501
@pkra
pkra deleted the 2501-roleInfo-CI branch April 8, 2026 12:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

editorial a change to an example, note, spelling, grammar, or is related to publishing or the repo spec:aria

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants