Skip to content

Upgrading release-it 9 to 10

Breaking9.8.3 → 10.4.5Breaking6Platform2Deprecated2New7Changed14Fixed21Other15

Full comparisonBack to release-it
BreakingUpgrade verdict

6 breaking changes and 2 platform requirement changes.

In plain terms
  • Configuration options that were already deprecated in version 9 no longer work, especially the distribution repository setting.
  • The command line debug flag is gone, but you can still get debug output by setting the DEBUG environment variable.
  • Removes deprecations added in v9.
  • The setting that controls changelog generation has moved from the scripts section to the git section of the config.
Must act Top 5 of 10 that need code or config changes

Node.js requirement changed in 10.0.0-rc.0: >=6 → >=8.

Adds form-data 2.3.3, git-url-parse 11.1.2, url-join 4.0.0.

Drops @webpro/is-subdir, babel-preset-env, babel-register, parse-repo.

Installs 567 packages in all (was 622).

What you must change

Breaking6
Removes options deprecated in v9, in particular the dist.repo config.
dist.repo
10.0.0CHANGELOG.mdSummarizedView source
Removes the --debug flag; DEBUG=release-it:* ... still works.
--debugDEBUG
10.0.0CHANGELOG.mdSummarizedView source
Removes deprecations added in v9.
10.0.0-rc.0GitHub ReleaseSummarizedView source
Moves the scripts.changelog configuration option to git.changelog.
scripts.changeloggit.changelog
10.4.3GitHub ReleaseSummarizedView source
Merges git.validate into git.init.
git.validategit.init
10.0.0-rc.0GitHub ReleaseSummarizedView source
Removes the --debug argument and enables debug in tests.
--debug
10.0.0-rc.0GitHub ReleaseSummarizedView source
Platform2
Drops support for Node v6.
10.0.0CHANGELOG.mdSummarizedView source
Removes support for Node v6.
10.0.0-rc.0GitHub ReleaseSummarizedView source

Deprecations to plan for

Deprecated2
Deprecates scripts.afterBump, which is the same as scripts.beforeStage; v11 supports arrays for scripts.
scripts.afterBumpscripts.beforeStagescripts
10.4.2GitHub ReleaseSummarizedView source
Deprecates the default prompt config.
10.1.0GitHub ReleaseSummarizedView source