3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-06-01 10:22:30 +02:00
Code Issues Projects Releases Packages Wiki Activity

feat(v2): allow targeting deployment branch with environment variable (#2396)

Browse source
This commit is contained in:
Luke Collier 2020-03-18 10:17:29 +00:00 • committed by GitHub
parent 8152b47bba
commit 51995fa237
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

4
packages/docusaurus/src/commands/deploy.ts
View file

@ -62,7 +62,9 @@ export async function deploy(siteDir: string): Promise<void> {
// github.io indicates organization repos that deploy via master. All others use gh-pages. // github.io indicates organization repos that deploy via master. All others use gh-pages.
const deploymentBranch = const deploymentBranch =
projectName.indexOf('.github.io') !== -1 ? 'master' : 'gh-pages'; process.env.DEPLOYMENT_BRANCH || projectName.indexOf('.github.io') !== -1
? 'master'
: 'gh-pages';
const githubHost = const githubHost =
process.env.GITHUB_HOST || siteConfig.githubHost || 'github.com'; process.env.GITHUB_HOST || siteConfig.githubHost || 'github.com';

1
website/docs/deployment.md
View file

@ -86,6 +86,7 @@ There are two more optional parameters that are set as environment variables:
| Name | Description | | Name | Description |
| --- | --- | | --- | --- |
| `USE_SSH` | Set to `true` to use SSH instead of the default HTTPS for the connection to the GitHub repo. | | `USE_SSH` | Set to `true` to use SSH instead of the default HTTPS for the connection to the GitHub repo. |
| `DEPLOYMENT_BRANCH` | The branch that the website will be deployed to, defaults to `gh-pages` for normal repos and `master` for repository names ending in `github.io`. |
| `CURRENT_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`. If nothing is set for this variable, then the current branch will be used. | | `CURRENT_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`. If nothing is set for this variable, then the current branch will be used. |
### Deploy ### Deploy