W3C home > Mailing lists > Public > public-secondscreen@w3.org > June 2015

[presentation-api] Pull Request: Spec pubrules and Echidna compliant, WD generation semi-automated

From: François Daoust via GitHub <sysbot+gh@w3.org>
Date: Wed, 10 Jun 2015 19:51:21 +0000
To: public-secondscreen@w3.org
Message-ID: <pull_request.opened-37397239-1433965880-sysbot+gh@w3.org>
tidoust has just submitted a new pull request for 

== Spec pubrules and Echidna compliant, WD generation semi-automated 
This commit should contain all updates needed to be able to publish 
drafts to /TR/ space at W3C on a semi-automated basis.

The basic principle is to use a dedicated "TR" branch where we 
generate the
Working Draft to publish. Any push to that branch will trigger Travis 
(provided it is enabled on the repository, obviously) that will, in 
send a publication request to Echidna at W3C with the right 

Actually publishing the spec from a local checkout of the gh-pages 
should look like:

git checkout TR
git merge gh-pages
make wd
git add releases/WD.html
git commit
git push w3c TR

Using a separate branch is not stricto senso necessary. I chose that 
1. to have Working Drafts remain somewhat hidden on GitHub, the 
branch will only contain the Editor's Draft and that sounds a good 
2. because it is easy to trigger Travis CI on a specific branch but 
not when
a when a specific file is updated.

In terms of changes, I updated the raw spec to be publication rules 
Echidna compliant, adding the editors IDs, updating the way version 
are managed, and the Status of This Document section so that it might 
be used
without modification in a published Working Draft.

I also created a "wd" Makefile rule to generate the releases/WD.html 
file that
can be provided to Echidna for immediate publication. The generated 
file is not part of this commit but has been checked with success 
Specberus, the new pubrules checker.

Note that the Makefile now uses "curl", "grep" and "sed" to extract 
the URL of
the latest published WD, used to compute the Previous Version link in 
generated Working Draft. This is all a bit hacky but should work fine 
in most
cases, except when publishing the spec more than once in a given day. 
"previous version" link can be manually checked and overwritten by 
some editor
before committing the working draft in any case.

Also note that Specberus does not like trailing spaces in "href" in 
"This version" and other similar links. We have them because of a 
of us using Tidy to enforce 80-character-long lines and Anolis that 
uses a
specific syntax based on comments for these links ("<!--begin-link-->"
"<!--end-link-->"). I worked around that using Anolis "[VERSION]" and
"[LATEST]" substitution strings that do not get truncated in the 
source spec
and thus do not generate spaces in the end. The issue has been 
reported to
Specberus folks:

I also added what I believe would be the right ECHIDNA manifest file 
and the
right .travis.yml configuration file to automate the publication. This
perhaps need to be adjusted when we try to publish the first working 

See https://github.com/w3c/presentation-api/pull/113
Received on Wednesday, 10 June 2015 19:51:23 UTC

This archive was generated by hypermail 2.4.0 : Friday, 17 January 2020 17:18:56 UTC