W3C home > Mailing lists > Public > public-publ-wg@w3.org > August 2017

RE: [Tooling] a new feature installed on our HTML/respec oriented repositories

From: Siegman, Tzviya - Hoboken <tsiegman@wiley.com>
Date: Mon, 21 Aug 2017 14:10:12 +0000
To: Ivan Herman <ivan@w3.org>, W3C Publishing Working Group <public-publ-wg@w3.org>
CC: Tobie Langel <tobie@codespeaks.com>
Message-ID: <SN1PR0201MB161522CC74DF83DAD9DB0C4BD5870@SN1PR0201MB1615.namprd02.prod.outlook.com>
This is great! Thanks, Tobie

Tzviya Siegman
Information Standards Lead
Wiley
201-748-6884
tsiegman@wiley.com 

-----Original Message-----
From: Ivan Herman [mailto:ivan@w3.org] 
Sent: Monday, August 21, 2017 3:21 AM
To: W3C Publishing Working Group <public-publ-wg@w3.org>
Cc: Tobie Langel <tobie@codespeaks.com>
Subject: [Tooling] a new feature installed on our HTML/respec oriented repositories

One of the problems with the Pull Request mechanism is that it is fairly difficult to see what changed, how the new version would really look like, etc. Although GitHub gives you the possibility to see the differences in the code, and while that is probably perfectly enough when GitHub is used for code development, that is not satisfactory when HTML files are concerned.

I have configured, called PR Review (developed by Tobie Langel) which helps this. If you look at the latest PR[1], you will see, at the bottom of the comment, references to 'Preview' and to 'Diff'. The former provides a link to a preview (ie, with respec processed), and the latter shows a readable diff (not a diff on the html source but on the way the text has changed). (In this very case the latter is not necessary very useful because Matt has changed a lot but, in general, I believe that can be extremely useful, too). This links, and the modification of the comment to add these links, is done automatically. Note that if an extra commit is made on the branch that is to be PR-d, the links are automatically updated.

I cc-d Tobie to thank him for this tool. I believe it will make our life easier.

Cheers

Ivan

P.S. Some of you may have seen that there has been a bunch of seemingly unnecessary PR-s on the pwpub repository a few weeks ago: that was due to the fact that some problems with respec, related to this tool, came to the fore. However, Tobie and Marcos have successfully tracked this down and the tool is now operational.

[1] https://github.com/w3c/wpub/pull/43

----
Ivan Herman, W3C 
Publishing@W3C Technical Lead
Home: http://www.w3.org/People/Ivan/
mobile: +31-641044153
ORCID ID: http://orcid.org/0000-0003-0782-2704
Received on Monday, 21 August 2017 14:10:38 UTC

This archive was generated by hypermail 2.3.1 : Monday, 23 October 2017 15:49:06 UTC