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 #502

Merged
merged 2 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.

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

This approach replaces the former approach based on Travis CI.

Note the ECHIDNA_TOKEN was added as secret to the repository.

@mfoltzgoogle There is no good and easy way to test this. At worst, publication fails and I'll investigate and fix parameters that I may have missed. Also note the switch to main as the default branch that contains the source code.


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
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.

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

Note the `ECHIDNA_TOKEN` has been added as secret to the repository.
The spec seems correct to me, but ReSpec complains that the `github` option
should rather be used when it builds the Candidate Recommendation Draft.

This reduces the number of links in the front matter in practice, which is a
good thing.
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! I guess we must simply ship this and fix in production if something breaks.

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

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

Looks like things are working from a quick glance. Thank you tor upgrading our publication flow @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.

None yet

3 participants