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.

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

Add action to publish epub:type to aria roles authoring guide #2693

Merged
merged 5 commits into from
Mar 17, 2025

Conversation

mattgarrish
Copy link
Member

While looking at moving the notes, I spotted that the authoring guide has a postprocess function call with no source script include for it. Guessing it accidentally got copied in while adding metadata.

Made me wonder why this was never flagged when the notes have been republished, and sure enough we're missing an action to publish it.

@iherman the only thing I'm unsure of here is the echidna token. I put the short name on the end for now, but please use your secret w3c powers to make sure it's correct.

@mattgarrish mattgarrish requested a review from iherman March 14, 2025 15:23
@mattgarrish
Copy link
Member Author

I've updated this PR to rename the yml files for the REC track documents back to .yml files.

Github allows you to disable workflows from the actions page, so we shouldn't need to resort to this hack anymore: https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/disabling-and-enabling-a-workflow

But after integrating this PR, we'll need to disable the REC publishing actions before merging anything else.

The paths in the yml files are all going to need updating, too, but leaving that part until we rearrange the notes.

@iherman
Copy link
Member

iherman commented Mar 15, 2025

@iherman the only thing I'm unsure of here is the echidna token. I put the short name on the end for now, but please use your secret w3c powers to make sure it's correct.

I am at a loss here, my apologies. Has that short name been approved and already in use before? If so, things should be o.k.; if not, we have to officially ask for it.

As for echidna, we need a secret per short name. If the short name changes, the secret token has to be regenerated (this will be the case for any note that we republish, as well as the EPUB 3.4 publications.

@mattgarrish
Copy link
Member Author

Has that short name been approved and already in use before?

Yes, the note was published: https://www.w3.org/TR/epub-aria-authoring-11/

And we have the approval: https://www.w3.org/2023/01/05-epub-minutes.html#resolution04

But it doesn't appear that a github action was ever created to have echnida auto-publish it along with the other notes. That's why I have no idea what the token should be. I copied a yml file for another note, but I don't know if there's a public way to look up what the token should be.

@mattgarrish
Copy link
Member Author

As for echidna, we need a secret per short name.

So it sounds like if we never set up auto-publishing for this note then we need to get one created? I was assuming tokens were created automatically whenever new documents are published.

@iherman
Copy link
Member

iherman commented Mar 16, 2025

As for echidna, we need a secret per short name.

So it sounds like if we never set up auto-publishing for this note then we need to get one created? I was assuming tokens were created automatically whenever new documents are published.

No, it was set up; I mean the secret key has been generated. But the short name was wrong, see my comment above.

@mattgarrish mattgarrish merged commit 27a1728 into main Mar 17, 2025
1 check passed
@mattgarrish mattgarrish deleted the actions/type-role-guide branch March 17, 2025 12:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants