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

Enable auto-publication of the spec to /TR #146

Merged
merged 3 commits into from
Apr 22, 2022
Merged

Conversation

tidoust
Copy link
Member

@tidoust tidoust commented Apr 15, 2022

This update enables auto-publication of the spec as Candidate Recommendation Draft to /TR, as agreed by the working group. It leverages the spec-prod action to do that.

This update also adjusts the workflow for the Editor's Draft itself. The source spec is now to be found in the main branch, and instead of publishing the source spec to GitHub Pages directly, the spec-prod action will rather deploy the generated spec. Among other things, this makes it possible to integrate the spec in Bikeshed's database for cross-referencing purpose (fixing #137).

The spec-prod action also takes care of running ReSpec on pull requests to validate changes from an editorial perspective.

Note the ECHIDNA_TOKEN was added as secret to the repository.

Related PR for the Presentation API: w3c/presentation-api#502


Preview | Diff

This update enables auto-publication of the spec as Candidate Recommendation
Draft to /TR, as agreed by the working group. It leverages the
[spec-prod action](https://github.com/w3c/spec-prod/) to do that.

This update also adjusts the workflow for the Editor's Draft itself. The source
spec is now to be found in the `main` branch, and instead of publishing the
source spec to GitHub Pages directly, the spec-prod action will rather deploy
the generated spec. Among other things, this makes it possible to integrate
the spec in Bikeshed's database for cross-referencing purpose (fixing w3c#137).

The spec-prod action also takes care of running ReSpec on pull requests to
validate changes from an editorial perspective.

Note the `ECHIDNA_TOKEN` was added as secret to the repository.
ReSpec requires a `crEnd` date when the spec's status is CR or CRD. It makes
sense for CR (the date appears in the Status of this Document section). It does
not really make sense for CRD (the date does not appear anywhere). Anyway,
adding the parameter to please the ReSpec and make the auto-publication process
succeed.
A `<dl>` cannot be used without `<dt>`. Switching to `<ul>` instead to contain
the list of conditions.

Needed to enable auto-publication since the spec-prod action validates the HTML.
Copy link
Member

@anssiko anssiko left a comment

Choose a reason for hiding this comment

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

Thanks!

@tidoust tidoust merged commit a2e218f into w3c:main Apr 22, 2022
github-actions bot added a commit that referenced this pull request Apr 22, 2022
SHA: a2e218f
Reason: push, by @tidoust

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@markafoltz
Copy link
Contributor

Looks like things are working smoothly. Thank you again @tidoust!

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.

3 participants