How to use Echidna with ReSpec and GitHub
YOU DON'T NEED TO ACTUALLY INSTALL ECHIDNA AT ALL!
Before you start - unfortunately, there are a few process things you need to do. These steps can take about 1-2 weeks to complete. Note however that you need to do that only once.
You will need the following:
- Working Group Approval to use the new process.
- A token from the W3C.
- The "editor ID" of each editor of the spec.
If you are updating a CR, you need to know if the update contains substantives changes or not.
In order to publish your document using the new process, you need to get consensus in your Working Group. You get this by emailing your group's mailing list. See, for example, how approval was requested for the WebApps WG.
The chair will generally put out a Call for Consensus (CFC), which can take about 1 week.
Once you get approval (or the CFC), keep the URL handy 'cause you will need it later to actually publish!
Then you will need to get the IDs for the Editors of your spec. You can find yours by going to your W3C profile:
You will need to add this ID to your ReSpec config using the w3cid property, like so:
editors: [{
name: "Spec Editor",
w3cid: 39125
}]If you want to submit a request to Echidna after each commit, you can configure Github Actions to take care of it.
spec-prod, a Github Action integrates Echidna, is highly recommended to automatically generate TR documents and publish them.
If you don't want to rely on GitHub Actions, you can use the tar method to publish to Echidna. You will first need to prepare a tar of your specification (including all the resources needed). Note, that you will need to submit your document to spec-generator first as Echidna will not know how to deal with a respec source document with the tar method.
Once you have the tar ready, you can submit it with the following command:
# using the W3C credentials
curl 'https://labs.w3.org/echidna/api/request' --user '<username>:<password>' -F "tar=@/some/path/spec.tar" -F "decision=<decisionUrl>"