Skip to content

CR publication workflow

Jump to bottom
Philippe Le Hegaret edited this page Aug 7, 2018 · 15 revisions

Starting July 2, 2018, Echidna is able to publish Candidate Recommendations. This page describes the different requirements you need to fulfill before submitting your CR to Echidna.

Types of Candidate Recommendations

Echidna can publish:

  • "ordinary" CR (coming from a WD)
  • CR update with substantive changes
  • CR update with editorial changes only

The first two cases require the Director's and Communication team's approvals and will also trigger a new Call for Exclusion. If you just publish a CR update with editorial changes only, you don't need the approvals and can submit your document to Echidna directly.

CR publication workflow

Request a transition request

The transition requests are now managed at https://github.com/w3c/transitions. The README.md of that repository offers templates to create pre-filled issues for new transition requests. The director will then make some comments and ultimately approve the request with the following comment 'Transition approved.'. The label 'Awaiting Publication' will need to be set. It's important that the title of the issue ends with the shortname of your specification. That's how Echidna will find the right issue when processing your request.

See also the source code of the transition checker used in Echidna.

Examples:

Draft announcement to the members

Once the transition is approved, you will need to send the draft transition to w3t-comm@w3.org. After a careful review of the draft, the Communication team will approve it by commenting on the GitHub issue 'Draft transition approved.'.

Before publishing a CR in Echidna

If your specification is on GitHub and the repository was configured to publish a WD/Note after each commit via a webhook, you may want to disable travis from your repository settings to avoid publishing a new WD after your next commit. You can re-enable it later if you are planning to publish regular CR with editorial updates.

If you are relying on a manifest based on ReSpec, you will also have to switch the status from specStatus=WD to specStatus=CR so spec-generator can generate the Candidate Recommendation.

Finally, make sure your document passes pubrules with the profile CR - Candidate Recommendation and the option Echidna-ready checked.

Request to Echidna

After you get all the necessary approvals, you can submit your document to Echidna as described in the wiki. When updating a CR, Echidna will assume it contains substantive changes by default. If you are only adding editorial changes, you can skip the transition/draft announcement steps by adding the following parameter editorial=true to your request, e.g.

curl 'https://labs.w3.org/echidna/api/request' --data 'url=<documentUrl>&decision=<decisionUrl>&token=<token>&editorial=true'
Clone this wiki locally