Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Specify input build for deployment #2723

Closed
krillboi opened this issue May 7, 2020 · 4 comments · Fixed by #2770
Closed

Specify input build for deployment #2723

krillboi opened this issue May 7, 2020 · 4 comments · Fixed by #2770
Labels
feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future. status: needs triage This issue has not been triaged by maintainers

Comments

@krillboi
Copy link

krillboi commented May 7, 2020

🚀 Feature

We would like to be able to specify an input for deployment - that is a folder with the whole documentation site built. This is because we would like to be able to:

  • Build the documentation
  • Then run some validation on that build
  • Supply this build for deployment instead of the deploy script building the documentaion again

Have you read the Contributing Guidelines on issues?

Yes.

Motivation

Speed up our deployment steps.

Pitch

Would open up the deployment script more. Could be used like yarn deploy --input "path/to/build".

@krillboi krillboi added feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future. status: needs triage This issue has not been triaged by maintainers labels May 7, 2020
@lex111
Copy link
Contributor

lex111 commented May 8, 2020

The docusaurus deploy command already has an option for this purpose, isn't that what you need? https://v2.docusaurus.io/docs/cli#docusaurus-deploy

@krillboi
Copy link
Author

krillboi commented May 11, 2020

I might be misunderstanding something, but isn't that option just what the folder for the output should be?

What I would like is for there to be an input option, so you're effectively skipping the build step of the deploy script because you're supplying a build yourself.

Basically our own deploy script would be something like:

yarn build #builds documentation into /path/to/build
do_some_test_on_build() #run some validation on build
yarn deploy --input /path/to/build #deploy will not build here when using input because we already did so with yarn build

@lex111
Copy link
Contributor

lex111 commented May 17, 2020

Fine, then we need a new option something like yarn deploy --skip-build, right?

@krillboi
Copy link
Author

Yeah that would work as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future. status: needs triage This issue has not been triaged by maintainers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants