UNPKG

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