Skip to content

Upgrading release-it 2 to 3

Breaking2.9.0 → 3.2.0Breaking14New8Changed23Fixed13Other44

Full comparisonBack to release-it
BreakingUpgrade verdict

14 breaking changes.

In plain terms
  • Publishing to npm now happens by default, so you may need to disable it explicitly.
  • The forcePublishSourceRepo option is gone; use the publish options instead.
  • The local config file has a new name, so rename it to keep your settings.
  • The --message command line shortcut no longer exists; set the commit message in config.
Must act Top 3 of 14 that need code or config changes

Adds async-retry 1.1.3, babel-plugin-transform-async-to-generator 6.24.1, babel-plugin-transform-es2015-modules-commonjs 6.26.0, babel-plugin-transform-runtime 6.23.0, babel-preset-env 1.6.1, babel-register 6.26.0, babel-runtime 6.26.0, bump-file 1.0.0, cpy 6.0.0, debug 3.1.0, globby 6.1.0, ora 1.3.0, supports-color 4.4.0, tmp-promise 1.0.3, yargs-parser 8.0.0.

Drops glob, graceful-fs, minimist, mkdirp, p-retry, when.

Installs 250 packages in all (was 142).

What you must change

Breaking14
npm.publish now defaults to true.
npm.publish
3.0.0GitHub ReleaseSummarizedView source
Removes npm.forcePublishSourceRepo; set npm.publish and dist.npm.publish to true as needed.
npm.forcePublishSourceReponpm.publishdist.npm.publish
3.0.0GitHub ReleaseSummarizedView source
Renames local configuration file .release.json to .release-it.json.
.release.json.release-it.json
3.0.0GitHub ReleaseSummarizedView source
Removes the --message shortcut; use src.commitMessage instead.
--messagesrc.commitMessage
3.0.0GitHub ReleaseSummarizedView source
Renames the prereleaseId option to preReleaseId.
prereleaseIdpreReleaseId
3.0.0GitHub ReleaseSummarizedView source
Removes src.beforeStageCommand; dist.beforeStageCommand remains.
src.beforeStageCommanddist.beforeStageCommandbuildCommand
3.0.0GitHub ReleaseSummarizedView source
Removes implicit verbose output; use --verbose as needed.
--verbose
3.0.0GitHub ReleaseSummarizedView source
Removes babel-preset-stage-0.
babel-preset-stage-0
3.0.0-beta.2GitHub ReleaseSummarizedView source
Removes @std/esm.
@std/esm
3.0.0-beta.2GitHub ReleaseSummarizedView source
Moves former githubAssets to github.assets and dist.github.assets.
githubAssetsgithub.assetsdist.github.assets
3.0.0GitHub ReleaseSummarizedView source
Requires setting github.release and/or dist.github.release to true as needed.
github.releasedist.github.release
3.0.0GitHub ReleaseSummarizedView source
release-it --debug is now accompanied by DEBUG=release-it:* release-it.
--debugDEBUG
3.0.0GitHub ReleaseSummarizedView source
Changes the local config path to .release-it.json.
.release-it.json
3.0.0-beta.6GitHub ReleaseSummarizedView source
Replaces release-it --debug with DEBUG=release-it:* release-it.
--debugDEBUG
3.0.0-beta.0GitHub ReleaseSummarizedView source