Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs auto-push to gh-pages branch #1689

Merged
merged 1 commit into from Mar 9, 2017
Merged

Conversation

tivac
Copy link
Contributor

@tivac tivac commented Mar 8, 2017

This modifies the existing travis script and changes the flow some so that docs will generate & auto push to the gh-pages branch when builds succeed on master.

Was going to use travis-scripts/update-branch since it would do this a bit more cleanly but it has no option to preserve files on the target branch which we need for archived versions. So gh-pages and some flopping around it is.

TODO once merged

  • Verify that gh-pages branch looks correct
  • Copy archived versions from lhorie/mithril into the correct location in the gh-pages branch
  • Set up Github Pages to use gh-pages branch (Only @lhorie can change repo settings)
  • Tweak mithril.js.org to point to Github pages (I don't know how to do that)
  • Rejoice at never manually pushing site updates again

Caveat I would love to have docs changes to next auto-generate docs for another site, something like mithril-next.js.org, but that doesn't seem easy currently. Closest I can get so far is to spend some time figuring out how to get it to build changes on next into some sort of ./next folder in the gh-pages branch.

@lhorie verbally (textually?) approved this work in gitter

@tivac tivac added the Area: Documentation For anything dealing mainly with the documentation itself label Mar 8, 2017
@tivac tivac self-assigned this Mar 8, 2017
@pygy
Copy link
Member

pygy commented Mar 8, 2017

What are the plans for the Gandalf builds?

@pygy
Copy link
Member

pygy commented Mar 8, 2017

@tivac semi-related: If you ever get around automating the change log, could you also give a look at the GH API for doing releases (#1676 (comment))?

@tivac
Copy link
Contributor Author

tivac commented Mar 8, 2017

What are the plans for the Gandalf builds?

The $(npm bin)/commit-changes line will commit the changes generated by before_script: npm run build when on the next branch, so there should be no changes there.

If you ever get around automating the change log, could you also give a look at the GH API for doing releases

I would love to do this, but it's more complicated. I've been enjoying using @studio/changes on my personal projects for changelog generation.

Something like release and a commit hook via husky and validate-commit-msg to ensure that commit messages describe the change level correctly might get it done. A bit wary of that level of tooling though since @lhorie has been reluctant in the past to go too heavy down that road.

@lhorie lhorie merged commit 622bd6e into MithrilJS:next Mar 9, 2017
@tivac tivac deleted the auto-publish branch April 7, 2017 17:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Documentation For anything dealing mainly with the documentation itself
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants