W3C home > Mailing lists > Public > public-webauthn@w3.org > April 2016

Re: index.html missing from repo master branch -- regen upon merges ?

From: J.C. Jones <jjones@mozilla.com>
Date: Thu, 7 Apr 2016 10:43:11 -0700
Message-ID: <CAObDDPDeSwNgCd99=DwvPZ_aWb+2mwCC8mxzg9V_GHVJKuRupw@mail.gmail.com>
To: "Hodges, Jeff" <jeff.hodges@paypal.com>
Cc: W3C WebAuthn WG <public-webauthn@w3.org>
Jeff,

The way I have Travis set up, it's always up-to-date on the gh-pages branch
[1]. On the master branch it's somewhat dangerous to keep as it's very easy
to cause merge conflicts on that file, prompting unexpected build failures.
For that reason, index.html is in the .gitignore. This is the choice used
in mt's i-d-template [2], which I used as the basis for our bikeshed CI
tooling.  Note that the ACME spec [3] has this same deal, where the
formatted version is only on the gh-pages branch.

It's possible to adjust the git commands in ghpages.mk [4] to ensure that,
in the event of a merge, the local copy always wins. In my experience
that's a bit brittle to do it in a way that doesn't accidentally catch
other files, but I'm happy to review and help test such a change.

J.C.

1) https://github.com/w3c/webauthn/blob/gh-pages/index.html
2) https://github.com/martinthomson/i-d-template
3) https://github.com/ietf-wg-acme/acme
4) https://github.com/w3c/webauthn/blob/master/lib/ghpages.mk

On Thu, Apr 7, 2016 at 10:26 AM, Hodges, Jeff <jeff.hodges@paypal.com>
wrote:

> Hubert & I notice that index.html missing from the github.com/w3c/webauthn
> repo master branch.
>
> index.html is the "formatted" output gen'd by bikeshed.  if you have
> bikeshed installed, running  make in your repo clone directory will
> generate it. (ie, see the Makefile)
>
> perhaps we should figure out a way that auto-generates index.html upon
> merges to master such that index.html tracks the current state of the
> post-merge(s) spec?
>
> =JeffH
>
>
>
>
>
Received on Thursday, 7 April 2016 17:43:59 UTC

This archive was generated by hypermail 2.4.0 : Thursday, 24 March 2022 20:38:14 UTC