Skip to content

Commit

Permalink
docs(v2): Update deployment.mdx (#3950)
Browse files Browse the repository at this point in the history
Include documentation on environment variable needed for Enterprise GitHub Pages deployment.
  • Loading branch information
samhrncir authored Dec 28, 2020
1 parent b5c46bd commit b54ec93
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions website/docs/deployment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,12 @@ Optional parameters, also set as environment variables:
| `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. |
| `GIT_PASS` | Password (or token) of the `git` user (specified by `GIT_USER`). For example, to facilitate non-interactive deployment (e.g. continuous deployment) |

GitHub enterprise installations should work in the same manner as github.com; you only need to set the organization's GitHub Enterprise host as an environment veriable:

| Name | Description |
| --- | --- |
| `GITHUB_HOST` | The domain name of your GitHub enterprise site. |

### Deploy

Finally, to deploy your site to GitHub Pages, run:
Expand Down

0 comments on commit b54ec93

Please sign in to comment.