search

w3c / openscreenprotocol

Open Screen Protocol
https://www.w3.org/TR/openscreenprotocol/
Other
91 stars 22 forks source link

Set up tavis-cl process to regenerate HTML files. #199

Closed markafoltz closed 2 years ago

markafoltz commented 5 years ago

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.

tidoust commented 5 years ago

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)

markafoltz commented 5 years ago

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 commented 5 years ago

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

markafoltz commented 5 years ago

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 commented 2 years ago

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