| 1 | # Changelog
|
| 2 |
|
| 3 | This document lists breaking changes for each major release.
|
| 4 |
|
| 5 | See the GitHub Releases page for detailed changelogs:
|
| 6 | [https://github.com/release-it/release-it/releases](https://github.com/release-it/release-it/releases)
|
| 7 |
|
| 8 | ## v11
|
| 9 |
|
| 10 | - The custom `conventional-changelog` increment (e.g. `"increment": "conventional:angular"`) with additional script
|
| 11 | configuration is replaced with a plugin. Please see
|
| 12 | [conventional changelog](https://github.com/release-it/release-it#conventional-changelog) how to use this plugin.
|
| 13 | - The `pkgFiles` option has been removed. If there's a need to bump other files than what `npm version` bumps, it should
|
| 14 | be (part of) a plugin.
|
| 15 | - By default, the latest version was derived from the latest Git tag. From v11, if the repo has a `package.json` then
|
| 16 | that `version` is used instead. The `use` option has been removed. Also see
|
| 17 | [latest version](https://github.com/release-it/release-it#latest-version).
|
| 18 | - `scripts.changelog` has been moved to `git.changelog`
|
| 19 |
|
| 20 | ## v10
|
| 21 |
|
| 22 | - Dropped support for Node v6
|
| 23 | - Deprecated options from v9 are removed, the `dist.repo` config in particular (also see
|
| 24 | [distribution repository](https://github.com/release-it/release-it#distribution-repository) for alternatives).
|
| 25 | - Drop the `--debug` flag. `DEBUG=release-it:* ...` still works.
|
| 26 |
|
| 27 | ## v9
|
| 28 |
|
| 29 | There should be no breaking changes, but there have been major internal refactorings and an improved UI. A bunch of new
|
| 30 | features and bug fixes have been implemented. Last but not least, the configuration structure is changed significantly.
|
| 31 | For this (backwards compatible) change, deprecation warnings are shown, and configurations must be migrated with the
|
| 32 | next major release (v10). See [deprecated.json](./conf/deprecated.json) for the changes, mainly:
|
| 33 |
|
| 34 | - All "command hooks" have been moved to `scripts.*`, and some have been renamed.
|
| 35 | - All `src.*` options have been moved to `git.*` (and `scripts.*`).
|
| 36 | - The `dist.repo` configuration and functionality has been removed.
|
| 37 |
|
| 38 | ## v8
|
| 39 |
|
| 40 | - Drop the `--force` flag. It's only use was to move a Git tag.
|
| 41 |
|
| 42 | ## v7
|
| 43 |
|
| 44 | - No longer adds untracked files to release commit. (#230)
|
| 45 |
|
| 46 | ## v6
|
| 47 |
|
| 48 | - Default value for `requireCleanWorkingDir` is now `true` (previously: `false`). (#173)
|
| 49 | - Skip prompt (interactive) if corresponding task (non-interactive) is disabled. E.g. `npm.publish: false` will also not
|
| 50 | show "publish" prompt.
|
| 51 |
|
| 52 | ## v5
|
| 53 |
|
| 54 | - Drop support for Node v4.
|
| 55 |
|
| 56 | [Release notes for v5](https://github.com/release-it/release-it/releases/tag/5.0.0-beta.0)
|
| 57 |
|
| 58 | ## v4
|
| 59 |
|
| 60 | - Use `shell.exec` for build commands by default (previously this required a `!` prefix).
|
| 61 |
|
| 62 | [Release notes for v4](https://github.com/release-it/release-it/releases/tag/4.0.0-rc.0)
|
| 63 |
|
| 64 | ## v3
|
| 65 |
|
| 66 | - Configuration filename must be `.release-it.json` (previously `.release.json`).
|
| 67 | - Refactored configuration structure in this file (and the CLI arguments with it).
|
| 68 |
|
| 69 | [Release notes for v3](https://github.com/release-it/release-it/releases/tag/3.0.0)
|
| 70 |
|
| 71 | ## v2
|
| 72 |
|
| 73 | - Build command is executed before git commit/push.
|
| 74 | - Configuration options are better organized. Most of them are backwards compatible with a deprecation notice.
|
| 75 |
|
| 76 | [Release notes for v2](https://github.com/release-it/release-it/releases/tag/2.0.0)
|
| 77 |
|
| 78 | ## v1
|
| 79 |
|
| 80 | Initial major release.
|
| 81 |
|
| 82 | [Release notes for v1](https://github.com/release-it/release-it/releases/tag/1.0.0)
|