3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-02 11:47:23 +02:00
Code Issues Projects Releases Packages Wiki Activity

Allow deploying docs from a branch other than master

Browse source 
Still have to deploy to `gh-pages`
This commit is contained in:
Joel Marcey 2017-11-17 14:26:08 -08:00
parent 59d5b58aa5
commit 16aa42a705
2 changed files with 10 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/getting-started-publishing.md
View file

@ -34,7 +34,9 @@ Most of the work to publish to GitHub pages is done for you automatically throug
- `CIRCLE_PROJECT_USERNAME`: The GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebookexperimental" GitHub organization.
- `CIRCLE_PROJECT_REPONAME`: The name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebookexperimental/docusaurus, so our repo name in this case would be "docusaurus".
- `GIT_USER`: The username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
- `CIRCLE_BRANCH`: The branch that contains the latest docs changes that will be deployed. Usually, "master".
- `CIRCLE_BRANCH`: The branch that contains the latest docs changes that will be deployed. Usually, the branch will be `master`, but it could be any branch (default or otherwise) except for `gh-pages`.
> We currently require the published documentation to be served from the `gh-pages` branch in your GitHub repo.
> The reason we prefix some of these parameters with `CIRCLE` is because Docusaurus recommends publishing your documentation continuously when changes are committed via [CircleCI](https://circleci.org).

9
lib/publish-gh-pages.js
View file

@ -31,11 +31,16 @@ if (!shell.which("git")) {
shell.exit(1);
}
if (CI_PULL_REQUEST || CIRCLE_BRANCH !== `master`) {
shell.echo("Skipping deploy");
if (CI_PULL_REQUEST) {
shell.echo("Skipping deploy on a pull request");
shell.exit(0);
}
if (CIRCLE_BRANCH === "gh-pages") {
shell.echo("Cannot deploy from a gh-pages branch. Only to it");
shell.exit(1);
}
if (shell.exec(`node ${__dirname}/build-files.js`).code) {
shell.echo("Error: generating html failed");
shell.exit(1);