feat: allow user to specify deploymentBranch property in docusaurus.config.js #5841
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
✔️ [V2] 🔨 Explore the source changes: 56ff039 🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/617e0c85272ddc0008be0a57 😎 Browse the preview: https://deploy-preview-5841--docusaurus-2.netlify.app |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-5841--docusaurus-2.netlify.app/ |
Josh-Cena
approved these changes
Oct 31, 2021
wpyoga
added a commit
to wpyoga/docusaurus
that referenced
this pull request
Oct 31, 2021
…onfig.js (facebook#5841) * feat: allow user to specify deploymentBranch property in docusaurus.config.js * docs: remove extra backtick * docs: fix broken code block
Josh-Cena
added a commit
that referenced
this pull request
Nov 10, 2021
* feat: allow GIT_USER env var to be unset if SSH is used * fix: packages/docusaurus/src/commands/deploy.ts Co-authored-by: Joshua Chen <sidachen2003@gmail.com> * feat: allow user to specify deploymentBranch property in docusaurus.config.js (#5841) * feat: allow user to specify deploymentBranch property in docusaurus.config.js * docs: remove extra backtick * docs: fix broken code block * docs: fix i18n routes to feature requests (#5843) * docs: fix i18n routes to feature requests * Add redirect rules * feat: allow GIT_USER env var to be unset if SSH is used * fix: packages/docusaurus/src/commands/deploy.ts Co-authored-by: Joshua Chen <sidachen2003@gmail.com> * fix: avoid escaping hyphen in regex * Refactor * Update deployment.mdx * Make SSH higher priority * Only infer but not override * Add tests * Fix tests * Fix Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Allows me to specify the deployment branch in docusaurus.config.js using a new
deploymentBranchproperty, instead of having to use an environment variable. Deployment branch is usually static, so IMHO it should be stored inside docusaurus.config.js .Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
I used this on my own GitHub Pages site. The repo name is
wpyoga.github.io, but I deploy to agh-pagesbranch, instead of the usually-defaultmasterormainbranch.Related PRs
If #5840 is merged, then no need to set USE_SSH=true when running
yarn deployon my local repo.