openscreenprotocol icon indicating copy to clipboard operation
openscreenprotocol copied to clipboard

Set up tavis-cl process to regenerate HTML files.

Open markafoltz opened this issue 6 years ago • 4 comments

Right now we have our generated HTML files checked into Git, which isn't great because merging any PR into trunk creates conflicts with all other open branches that Git can't automatically resolve. (Bikeshed includes some hash of the document in the generated HTML.)

I am wondering if we can set up a tavis-cl workflow to re-generate the HTML on a commit so we can avoid this situation.

markafoltz avatar Aug 28 '19 23:08 markafoltz

The How to Auto-Deploy Bikeshed Specs guide details steps needed to do that. The main thing being that we'll need two branche (e.g. master with the source code and gh-pages with the generated spec)

tidoust avatar Sep 16 '19 23:09 tidoust

Thanks @tidoust! As we discussed, it should be okay to make gh-pages the publication branch (as that's the standard across other specs). Folks with open pull requests will need to adjust the base branch through the WebUI or the git commandline.

https://help.github.com/en/articles/changing-the-base-branch-of-a-pull-request

CC @pthatcherg @takumif

markafoltz avatar Sep 18 '19 00:09 markafoltz

And let's call the base branch "master".

markafoltz avatar Sep 18 '19 00:09 markafoltz

This seems to be working well for the spec!

One question: Will checkins to the markdown files (*.md) automatically be merged from the master branch to the gh-pages branch?

markafoltz avatar Sep 20 '19 05:09 markafoltz

Closing as the GitHub workflows have been operating smoothly (after fixing the Pygments issue).

markafoltz avatar Sep 09 '22 23:09 markafoltz