feat!: run build by default before deploy #7195
Merged
Conversation
This file contains hidden or 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
📊 Benchmark resultsComparing with 0d48c28
|
ndhoule
changed the base branch from
main
to
nathanhoule/cpla-2545-change-ntl-deploy-to-build-by-default--refactor-types
ndhoule
force-pushed
the
nathanhoule/cpla-2545-change-ntl-deploy-to-build-by-default
branch
4 times, most recently
from
fa80263 to
5f44426
Compare
ndhoule
force-pushed
the
nathanhoule/cpla-2545-change-ntl-deploy-to-build-by-default--refactor-types
branch
from
9dc32fe to
24376c5
Compare
Base automatically changed from
nathanhoule/cpla-2545-change-ntl-deploy-to-build-by-default--refactor-types
to
main
April 16, 2025 21:30
ndhoule
force-pushed
the
nathanhoule/cpla-2545-change-ntl-deploy-to-build-by-default
branch
from
5f44426 to
6a799b0
Compare
serhalp
force-pushed
the
nathanhoule/cpla-2545-change-ntl-deploy-to-build-by-default
branch
from
6a799b0 to
a4ab697
Compare
serhalp
force-pushed
the
nathanhoule/cpla-2545-change-ntl-deploy-to-build-by-default
branch
from
a4ab697 to
433b1c4
Compare
This small change updates the `deploy` command to run the configured `build` command before deployment. Users who prefer the previous behavior can opt out by specifying `--no-build` when running `netlify deploy`.
serhalp
force-pushed
the
nathanhoule/cpla-2545-change-ntl-deploy-to-build-by-default
branch
from
433b1c4 to
db74b2a
Compare
serhalp
reviewed
Apr 29, 2025
| @@ -109,7 +109,19 @@ Support for package.json's main field, and intrinsic index.js entrypoints are co | |||
| 'build', | |||
| ), | |||
| ) | |||
| .option('--build', 'Run build command before deploying', false) | |||
| .addOption( | |||
| new Option('--build', 'Do not use - this is now the default. Will be removed in future versions.') | |||
There was a problem hiding this comment.
FWIW I don't think this string can ever be seen
There was a problem hiding this comment.
Yeah these only get added to generated cli.netlify.com docs
There was a problem hiding this comment.
Well, because we have hideHelp() it isn't even included there
serhalp
deleted the
nathanhoule/cpla-2545-change-ntl-deploy-to-build-by-default
branch
serhalp
added a commit
that referenced
this pull request
May 1, 2025
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.
Summary
This updates the
deploycommand to run the configuredbuildcommand before deployment by default. Previously, this was achieved by passing the--buildflag.To opt into the previous behavior, users can now specify
netlify deploy --no-build.Why are we changing this?
This has long been one of the most common sources of confusion with the Netlify CLI. Developers expect a "deploy" command to deploy their project. We're making this change to follow the Principle of Least Surprise and streamline the experience for new users.
Upgrading
(most common) Build and deploy
Remove the
--buildflag:netlify deploy --build [...] # before→
netlify deploy [...] # afterSeparate build and deploy
Warning
Make sure your deploy command runs in your expected environment, e.g. if you were running
FOO=bar netlify build && netlify deploy, make sureFOOis visible to the deploy command, which is now running the build:FOO=bar netlify deploy.Collapse into one command, if you can:
→
netlify deploy # afterOtherwise, add the
--no-buildflag:→
(rare) Deploy without build step
Add the
--no-buildflag:netlify deploy [...] # before (there was no `--build` here)→