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

Publish docs automatically #38

Closed
shawnbot opened this issue May 25, 2018 · 2 comments · Fixed by #224
Closed

Publish docs automatically #38

shawnbot opened this issue May 25, 2018 · 2 comments · Fixed by #224

Comments

@shawnbot
Copy link
Contributor

Currently our process of running npm run build to update the docs directory (so that we can then publish to GitHub Pages) is a bit tedious and error-prone because:

  1. It inevitably causes merge conflicts
  2. It's a manual step that I often forget to run before pushing
  3. It won't happen automatically when we merge branches

I propose that we build the site on CI (which also ensures that the site always builds) and publish it from there, ideally to a branch-specific URL on the gh-pages branch so that the URL would be, for instance, https://primer.github.io/primer-react/preview/my-branch-name/.

@shawnbot shawnbot added the 🚧 blocked Someone or something is preventing this from moving forward label May 29, 2018
@shawnbot
Copy link
Contributor Author

Note: I'm marking this as blocked because we have to either start paying for Travis or make this repo public in order to get it building on CI again.

@shawnbot shawnbot moved this from v0.0.6-beta To Do to Backlog in Primer Components release tracking 📋 Jun 25, 2018
@shawnbot shawnbot removed the 🚧 blocked Someone or something is preventing this from moving forward label Jul 2, 2018
@shawnbot shawnbot mentioned this issue Jul 20, 2018
7 tasks
@shawnbot shawnbot moved this from Backlog to v0.0.12-beta To Do in Primer Components release tracking 📋 Jul 20, 2018
@shawnbot shawnbot moved this from v0.0.12-beta To Do to Backlog in Primer Components release tracking 📋 Jul 23, 2018
@shawnbot shawnbot moved this from Backlog to Ready in Primer Components release tracking 📋 Aug 17, 2018
@shawnbot
Copy link
Contributor Author

This will actually be done via PRs if we decide to merge #226.

@shawnbot shawnbot moved this from v2.0.1-beta to 🙇‍♀️ WIP in Primer Components release tracking 📋 Aug 22, 2018
@shawnbot shawnbot changed the title Publish docs from CI Publish docs automatically Aug 22, 2018
@shawnbot shawnbot moved this from 🙇‍♀️ WIP to v2.0.1-beta Completed in Primer Components release tracking 📋 Aug 24, 2018
@emplums emplums mentioned this issue Aug 31, 2018
7 tasks
@emplums emplums moved this from v2.0.2-beta Completed to 🚢Published in Primer Components release tracking 📋 Sep 10, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

1 participant