W3C home > Mailing lists > Public > spec-prod@w3.org > January to March 2017

[pr-preview] announcement

From: Tobie Langel <tobie@codespeaks.com>
Date: Tue, 07 Mar 2017 02:37:54 +0100
Message-Id: <1488850674.1129281.902652536.215F2790@webmail.messagingengine.com>
To: spec-prod@w3.org
Hi all,

I wrote a little tool earlier this year to help me cope with reviewing
WebIDL pull requests.

Interest from a few people convinced me to spend a bit of time turning
it into a GitHub integration[1], which I did:

https://github.com/tobie/pr-preview

Whenever there's a new PR (or activity on an existing one) it generates
the proposed spec (which can use either Bikeshed or Respec), an HTML
diff of it, and adds links to both to the bottom of the PR.

See for example:
https://github.com/heycam/webidl/pull/323#issue-210636452

The code's open-source. The integration is running on free Heroku
hardware and an AWS S3 bucket, so the costs are rather contained for now
and should hopefully stay so.

WHATWG and WICG have started to use it and other WG are welcome to do so
too.

I've designed the integration so it's easy for an org to do a blanket
install (it's a one click install [2]) and for individual repositories
to op-in to by adding a config file[3] to their repo. There's even a
little tool to help you create and validate your config file and turn it
into a PR [4].

This wouldn't have been possible without the help of Dom (which handled
all my code change request for the HTML diff), Bikeshed's build service
(which plinss maintains), ReSpec's build service and HTML diff (both
also maintained by Dom). Thanks also to the guinea pigs who helped test
this and Google who sponsored the original project.

Hope you find it useful.

Best,

--tobie

---
[1]: GitHub integrations are a new feature GH is beta testing. It allows
turning bot apps into one-click install handling key exchanges on your
behalf which is rather nice.
[2]: https://github.com/integration/pr-preview
[3]: https://github.com/tobie/pr-preview#configuration-file
[4]: https://tobie.github.io/pr-preview/config.html
Received on Tuesday, 7 March 2017 01:38:21 UTC

This archive was generated by hypermail 2.3.1 : Tuesday, 7 March 2017 01:38:22 UTC