feat(cli): docusaurus deploy should support a --target-dir option #9767
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]
To edit notification comments on pull requests, go to your Netlify site configuration. |
⚡️ Lighthouse report for the deploy preview of this PR
|
slorber
changed the title
slorber
changed the title
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| } | ||
|
|
||
| // Clear out any existing contents in the target directory | ||
| shellExecLog(`git rm -rf ${targetDirectory}`); |
Check warning
Code scanning / CodeQL
Unsafe shell command constructed from library input Medium
|
Thanks, LGTM. I simplified your implementation but overall keep the intent. I confirm I can run: yarn build:website:fast
yarn workspace website deploy --skip-build
yarn workspace website deploy --skip-build --target-dir subdirThen the build folder is deployed at the gh-branch root: https://github.com/facebook/docusaurus/tree/gh-pages And then also to the subdir, without erasing what's at the root: https://github.com/facebook/docusaurus/tree/gh-pages/subdir So, it works as intended, even though we don't have great test coverage for this feature 😅 |
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.
Pre-flight checklist
Motivation
The deploy script makes a hard assumption that the remote repository only stores Docusaurus files.
In our case we have a
CNAMEfile in the root of the repo and therefore have placed all Docusaurus files in adocsfolder. Therefore, we cannot utilize this scripts since we can't specify the target directory.This PR adds a CLI option to specify the target directory and ensures that one the target directory is cleared out while the rest of the repo is left intact.
Guide for reviewer
This is an initial attempt to see if it is something that is worth finalizing and goes in the direction the maintainers of the project would like to see.
The PR is best reviewed commit by commit where each commit attempts to apply a single change. Hopefully this can help clarify if I have misunderstood how things should be implemented.
Test Plan
Would have loved to have #7714 merged for automatic validation of these changes.
Failing a snapshot test right now, I'm not a Javascript native developer and don't feel comfortable updating snapshots without understanding the implication.
The test that is currently failing should fail since I have actually added a new prop.
Test links
Deploy preview: https://deploy-preview-_____--docusaurus-2.netlify.app/
Related issues/PRs