release-it 15.10.0 → 15.10.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +192 -141
  2. package/package.json +17 -9
package/README.md CHANGED
@@ -1,37 +1,23 @@
1
1
  # Release It! 🚀
2
2
 
3
- 🚀 Generic CLI tool to automate versioning and package publishing related tasks:
3
+ 🚀 Generic CLI tool to automate versioning and package publishing-related tasks:
4
4
 
5
5
  <img align="right" src="./docs/assets/release-it.svg?raw=true" height="280">
6
6
 
7
7
  - Bump version (in e.g. `package.json`)
8
- - [Git commit, tag, push](#git)
9
- - Execute any (test or build) commands using [hooks](#hooks)
10
- - [Create release at GitHub](#github-releases) or [GitLab](#gitlab-releases)
11
- - [Generate changelog](#changelog)
12
- - [Publish to npm](#publish-to-npm)
13
- - [Manage pre-releases](#manage-pre-releases)
14
- - Extend with [plugins](#plugins)
15
- - Release from any [CI/CD environment](./docs/ci.md)
8
+ - [Git commit, tag, push][1]
9
+ - Execute any (test or build) commands using [hooks][2]
10
+ - [Create release at GitHub][3] or [GitLab][4]
11
+ - [Generate changelog][5]
12
+ - [Publish to npm][6]
13
+ - [Manage pre-releases][7]
14
+ - Extend with [plugins][8]
15
+ - Release from any [CI/CD environment][9]
16
16
 
17
17
  Use release-it for version management and publish to anywhere with its versatile configuration, a powerful plugin
18
18
  system, and hooks to execute any command you need to test, build, and/or publish your project.
19
19
 
20
- [![Action Status](https://github.com/release-it/release-it/workflows/Cross-OS%20Tests/badge.svg)](https://github.com/release-it/release-it/actions)
21
- [![npm version](https://badge.fury.io/js/release-it.svg)](https://www.npmjs.com/package/release-it)
22
-
23
- ## Announcement
24
-
25
- The latest major version is v15, supporting Node.js 14 and up (as Node.js v12 is EOL). Use release-it v14 for
26
- environments running Node.js v10 and v12. Also see [CHANGELOG.md](./CHANGELOG.md).
27
-
28
- ## Links
29
-
30
- - See [CHANGELOG.md](./CHANGELOG.md) for major/breaking updates, and
31
- [releases](https://github.com/release-it/release-it/releases) for a detailed version history.
32
- - To **contribute**, please read [CONTRIBUTING.md](./.github/CONTRIBUTING.md) first.
33
- - Please [open an issue](https://github.com/release-it/release-it/issues/new) if anything is missing or unclear in this
34
- documentation.
20
+ [![Action Status][11]][10] [![npm version][13]][12]
35
21
 
36
22
  ## Installation
37
23
 
@@ -56,68 +42,53 @@ npm install -D release-it
56
42
  "release": "release-it"
57
43
  },
58
44
  "devDependencies": {
59
- "release-it": "*"
45
+ "release-it": "^15.10.0"
60
46
  }
61
47
  }
62
48
  ```
63
49
 
64
- Now you can run `npm run release` from the command line (put release-it arguments behind the `-- `):
65
-
66
- ```bash
67
- npm run release
68
- npm run release -- minor --ci
69
- ```
70
-
71
- ### Global Installation
72
-
73
- #### Using npx or npm
50
+ ## Usage
74
51
 
75
- Use npx to run release-it directly from anywhere:
52
+ Run release-it from the root of the project using either `npm run` or `npx`:
76
53
 
77
54
  ```bash
55
+ npm run release
78
56
  npx release-it
79
57
  ```
80
58
 
81
- Or use npm to install and run release-it globally:
59
+ You will be prompted to select the new version, and more prompts will follow based on your configuration.
82
60
 
83
- ```bash
84
- npm install -g release-it
85
- ```
61
+ ## Experimental: knowledge base
86
62
 
87
- #### Using Homebrew
63
+ You might want to ask your questions in the [Release It! knowledge base][14] (powered by OpenAI and [7-docs][15]). This
64
+ is an experimental knowledge base, answers may be incorrect.
88
65
 
89
- ```bash
90
- brew install release-it
91
- ```
66
+ ## Yarn
92
67
 
93
- ## Usage
68
+ Using Yarn? Please see the [npm section on Yarn][16].
94
69
 
95
- Release a new version:
70
+ ## Monorepos
96
71
 
97
- ```bash
98
- release-it
99
- ```
100
-
101
- You will be prompted to select the new version, and more prompts will follow based on your configuration.
72
+ Using a monorepo? Please see this [monorepo recipe][17].
102
73
 
103
- Run release-it from the root of the project to prevent potential issues.
74
+ ## Global Installation
104
75
 
105
- ## Dry Runs
76
+ Per-project installation as shown above is recommended, but global installs are supported as well:
106
77
 
107
- Use `--dry-run` to show the interactivity and the commands it _would_ execute.
78
+ - From npm: `npm install -g release-it`
79
+ - From Homebrew: `brew install release-it`
108
80
 
109
- See [Dry Runs](./docs/dry-runs.md) for more details.
81
+ ## GitHub Actions
110
82
 
111
- To print the next version without releasing anything, add the `--release-version` flag.
83
+ Want to use release-it with GitHub Actions to fully automate the whole process? Enjoy this great walk-through: [How to
84
+ use GitHub Actions & Release-It to Easily Release Your Code][18] (by [David from Kodaps][19]).
112
85
 
113
- To print the changelog without releasing anything, add the `--changelog` flag.
86
+ See [Continuous Integration environments][9] for more details.
114
87
 
115
88
  ## Configuration
116
89
 
117
- Out of the box, release-it has sane defaults, and [plenty of options](./config/release-it.json) to configure it. Most
118
- projects use a `.release-it.json` in the project root, or a `release-it` property in `package.json`.
119
-
120
- → See [Configuration](./docs/configuration.md) for more details.
90
+ Out of the box, release-it has sane defaults, and [plenty of options][20] to configure it. Most projects use a
91
+ `.release-it.json` file in the project root, or a `release-it` property in `package.json`.
121
92
 
122
93
  Here's a quick example `.release-it.json`:
123
94
 
@@ -132,6 +103,8 @@ Here's a quick example `.release-it.json`:
132
103
  }
133
104
  ```
134
105
 
106
+ → See [Configuration][21] for more details.
107
+
135
108
  ## Interactive vs. CI mode
136
109
 
137
110
  By default, release-it is **interactive** and allows you to confirm each task before execution:
@@ -139,7 +112,7 @@ By default, release-it is **interactive** and allows you to confirm each task be
139
112
  <img src="./docs/assets/release-it-interactive.gif?raw=true" height="290">
140
113
 
141
114
  By using the `--ci` option, the process is fully automated without prompts. The configured tasks will be executed as
142
- demonstrated in the first animation above. On a Continuous Integration (CI) environment, this non-interactive mode is
115
+ demonstrated in the first animation above. In a Continuous Integration (CI) environment, this non-interactive mode is
143
116
  activated automatically.
144
117
 
145
118
  Use `--only-version` to use a prompt only to determine the version, and automate the rest.
@@ -148,16 +121,15 @@ Use `--only-version` to use a prompt only to determine the version, and automate
148
121
 
149
122
  How does release-it determine the latest version?
150
123
 
151
- 1. For projects with a `package.json`, its `version` will be used (see [npm](./docs/npm.md) to skip this).
152
- 2. Otherwise, release-it uses the latest Git tag to determine which version should be released.
153
- 3. As a last resort, `0.0.0` will be used as the latest version.
124
+ 1. For projects with a `package.json`, its `version` will be used (see [npm][22] to skip this).
125
+ 2. Otherwise, release-it uses the latest Git tag to determine which version should be released.
126
+ 3. As a last resort, `0.0.0` will be used as the latest version.
154
127
 
155
128
  Alternatively, a plugin can be used to override this (e.g. to manage a `VERSION` or `composer.json` file):
156
129
 
157
- - [@release-it/bumper](https://github.com/release-it/bumper) to read from or bump the version in any file
158
- - [@release-it/conventional-changelog](https://github.com/release-it/conventional-changelog) to get a recommended bump
159
- based on commit messages
160
- - [release-it-calver-plugin](https://github.com/casmith/release-it-calver-plugin) to use CalVer (Calendar Versioning)
130
+ - [@release-it/bumper][23] to read from or bump the version in any file
131
+ - [@release-it/conventional-changelog][24] to get a recommended bump based on commit messages
132
+ - [release-it-calver-plugin][25] to use CalVer (Calendar Versioning)
161
133
 
162
134
  Add the `--release-version` flag to print the **next** version without releasing anything.
163
135
 
@@ -166,67 +138,68 @@ Add the `--release-version` flag to print the **next** version without releasing
166
138
  Git projects are supported well by release-it, automating the tasks to stage, commit, tag and push releases to any Git
167
139
  remote.
168
140
 
169
- → See [Git](./docs/git.md) for more details.
141
+ → See [Git][26] for more details.
170
142
 
171
143
  ## GitHub Releases
172
144
 
173
145
  GitHub projects can have releases attached to Git tags, containing release notes and assets. There are two ways to add
174
- [GitHub releases](https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases) in your
175
- release-it flow:
146
+ [GitHub releases][27] in your release-it flow:
176
147
 
177
- 1. Automated (requires a `GITHUB_TOKEN`)
178
- 2. Manual (using the GitHub web interface with pre-populated fields)
148
+ 1. Automated (requires a `GITHUB_TOKEN`)
149
+ 2. Manual (using the GitHub web interface with pre-populated fields)
179
150
 
180
- → See [GitHub Releases](./docs/github-releases.md) for more details.
151
+ → See [GitHub Releases][28] for more details.
181
152
 
182
153
  ## GitLab Releases
183
154
 
184
- GitLab projects can have releases attached to Git tags, containing release notes and assets. To automate
185
- [GitLab releases](https://docs.gitlab.com/ce/user/project/releases/):
155
+ GitLab projects can have releases attached to Git tags, containing release notes and assets. To automate [GitLab
156
+ releases][29]:
186
157
 
187
158
  - Configure `gitlab.release: true`
188
- - Obtain a [personal access token](https://gitlab.com/profile/personal_access_tokens) (release-it only needs the "api"
189
- scope).
190
- - Make sure the token is [available as an environment variable](./docs/environment-variables.md).
159
+ - Obtain a [personal access token][30] (release-it only needs the "api" scope).
160
+ - Make sure the token is [available as an environment variable][31].
191
161
 
192
- → See [GitLab Releases](./docs/gitlab-releases.md) for more details.
162
+ → See [GitLab Releases][32] for more details.
193
163
 
194
164
  ## Changelog
195
165
 
196
166
  By default, release-it generates a changelog, to show and help select a version for the new release. Additionally, this
197
167
  changelog serves as the release notes for the GitHub or GitLab release.
198
168
 
199
- The [default command](./config/release-it.json) is based on `git log ...`. This setting (`git.changelog`) can be
200
- overridden. To further customize the release notes for the GitHub or GitLab release, there's `github.releaseNotes` or
201
- `gitlab.releaseNotes`. Make sure any of these commands output the changelog to `stdout`. Plugins are available for:
169
+ The [default command][20] is based on `git log ...`. This setting (`git.changelog`) can be overridden. To further
170
+ customize the release notes for the GitHub or GitLab release, there's `github.releaseNotes` or `gitlab.releaseNotes`.
171
+ Make sure any of these commands output the changelog to `stdout`. Note that release-it by default is agnostic to commit
172
+ message conventions. Plugins are available for:
202
173
 
203
174
  - GitHub and GitLab Releases
204
175
  - auto-changelog
205
176
  - Conventional Changelog
206
177
  - Keep A Changelog
207
178
 
208
- See [Changelog](./docs/changelog.md) for more details.
179
+ To print the changelog without releasing anything, add the `--changelog` flag.
180
+
181
+ → See [Changelog][33] for more details.
209
182
 
210
183
  ## Publish to npm
211
184
 
212
185
  With a `package.json` in the current directory, release-it will let `npm` bump the version in `package.json` (and
213
186
  `package-lock.json` if present), and publish to the npm registry.
214
187
 
215
- → See [Publish to npm](./docs/npm.md) for more details.
188
+ → See [Publish to npm][22] for more details.
216
189
 
217
190
  ## Manage pre-releases
218
191
 
219
192
  With release-it, it's easy to create pre-releases: a version of your software that you want to make available, while
220
- it's not in the stable semver range yet. Often "alpha", "beta", and "rc" (release candidate) are used as identifier for
193
+ it's not in the stable semver range yet. Often "alpha", "beta", and "rc" (release candidate) are used as identifiers for
221
194
  pre-releases. An example pre-release version is `2.0.0-beta.0`.
222
195
 
223
- → See [Manage pre-releases](./docs/pre-releases.md) for more details.
196
+ → See [Manage pre-releases][34] for more details.
224
197
 
225
198
  ## Update or re-run existing releases
226
199
 
227
200
  Use `--no-increment` to not increment the last version, but update the last existing tag/version.
228
201
 
229
- This may be helpful in cases where the version was already incremented. Here's a few example scenarios:
202
+ This may be helpful in cases where the version was already incremented. Here are a few example scenarios:
230
203
 
231
204
  - To update or publish a (draft) GitHub Release for an existing Git tag.
232
205
  - Publishing to npm succeeded, but pushing the Git tag to the remote failed. Then use
@@ -250,8 +223,8 @@ Use the optional `:plugin` part in the middle to hook into a life cycle method e
250
223
  The core plugins include `version`, `git`, `npm`, `github`, `gitlab`.
251
224
 
252
225
  Note that hooks like `after:git:release` will not run when either the `git push` failed, or when it is configured not to
253
- be executed (e.g. `git.push: false`). See [execution order](./docs/plugins.md#execution-order) for more details on
254
- execution order of plugin lifecycle methods.
226
+ be executed (e.g. `git.push: false`). See [execution order][35] for more details on execution order of plugin lifecycle
227
+ methods.
255
228
 
256
229
  All commands can use configuration variables (like template strings). An array of commands can also be provided, they
257
230
  will run one after another. Some example release-it configuration:
@@ -268,8 +241,7 @@ will run one after another. Some example release-it configuration:
268
241
  }
269
242
  ```
270
243
 
271
- The variables can be found in the [default configuration](./config/release-it.json). Additionally, the following
272
- variables are exposed:
244
+ The variables can be found in the [default configuration][20]. Additionally, the following variables are exposed:
273
245
 
274
246
  ```text
275
247
  version
@@ -296,71 +268,150 @@ release-it --'hooks.after:release="echo Successfully released ${name} v${version
296
268
 
297
269
  Using Inquirer.js inside custom hook scripts might cause issues (since release-it also uses this itself).
298
270
 
299
- ## Plugins
300
-
301
- Since v11, release-it can be extended in many, many ways. Here are some plugins:
271
+ ## Dry Runs
302
272
 
303
- | Plugin | Description |
304
- | -------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
305
- | [@release-it/bumper](https://github.com/release-it/bumper) | Read & write the version from/to any file |
306
- | [@release-it/conventional-changelog](https://github.com/release-it/conventional-changelog) | Provides recommended bump, conventional-changelog, and updates `CHANGELOG.md` |
307
- | [@release-it/keep-a-changelog](https://github.com/release-it/keep-a-changelog) | Maintain CHANGELOG.md using the Keep a Changelog standards |
308
- | [@release-it-plugins/lerna-changelog](https://github.com/release-it-plugins/lerna-changelog) | Integrates lerna-changelog into the release-it pipeline |
309
- | [@release-it-plugins/workspaces](https://github.com/release-it-plugins/workspaces) | Releases each of your projects configured workspaces |
310
- | [release-it-calver-plugin](https://github.com/casmith/release-it-calver-plugin) | Enables Calendar Versioning (calver) with release-it |
311
- | [@grupoboticario/news-fragments](https://github.com/grupoboticario/news-fragments) | An easy way to generate your changelog file |
312
- | [@j-ulrich/release-it-regex-bumper](https://github.com/j-ulrich/release-it-regex-bumper) | Regular expression based version read/write plugin for release-it |
273
+ Use `--dry-run` to show the interactivity and the commands it _would_ execute.
313
274
 
314
- Internally, release-it uses its own plugin architecture (for Git, GitHub, GitLab, npm).
275
+ See [Dry Runs][36] for more details.
315
276
 
316
- See all [release-it plugins on npm](https://www.npmjs.com/search?q=keywords:release-it-plugin).
277
+ ## Troubleshooting & debugging
317
278
 
318
- See [plugins](./docs/plugins.md) for documentation to write plugins.
279
+ - With `release-it --verbose` (or `-V`), release-it prints the output of every user-defined [hook][2].
280
+ - With `release-it -VV`, release-it also prints the output of every internal command.
281
+ - Use `NODE_DEBUG=release-it:* release-it [...]` to print configuration and more error details.
319
282
 
320
- ## Distribution repository
283
+ Use `verbose: 2` in a configuration file to have the equivalent of `-VV` on the command line.
321
284
 
322
- Deprecated. Please see [distribution repository](./docs/recipes/distribution-repo.md) for more details.
285
+ ## Plugins
323
286
 
324
- ## Metrics
287
+ Since v11, release-it can be extended in many, many ways. Here are some plugins:
325
288
 
326
- In release-it v15, anonymous metrics have been removed from the codebase and no data is sent or stored anywhere.
289
+ | Plugin | Description |
290
+ | ----------------------------------------- | ----------------------------------------------------------------------------- |
291
+ | [@release-it/bumper][23] | Read & write the version from/to any file |
292
+ | [@release-it/conventional-changelog][24] | Provides recommended bump, conventional-changelog, and updates `CHANGELOG.md` |
293
+ | [@release-it/keep-a-changelog][37] | Maintain CHANGELOG.md using the Keep a Changelog standards |
294
+ | [@release-it-plugins/lerna-changelog][38] | Integrates lerna-changelog into the release-it pipeline |
295
+ | [@release-it-plugins/workspaces][39] | Releases each of your projects configured workspaces |
296
+ | [release-it-calver-plugin][25] | Enables Calendar Versioning (calver) with release-it |
297
+ | [@grupoboticario/news-fragments][40] | An easy way to generate your changelog file |
298
+ | [@j-ulrich/release-it-regex-bumper][41] | Regular expression based version read/write plugin for release-it |
327
299
 
328
- ## Troubleshooting & debugging
300
+ Internally, release-it uses its own plugin architecture (for Git, GitHub, GitLab, npm).
329
301
 
330
- - With `release-it --verbose` (or `-V`), release-it prints the output of every user-defined [hook](#hooks).
331
- - With `release-it -VV`, release-it also prints the output of every internal command.
332
- - Use `NODE_DEBUG=release-it:* release-it [...]` to print configuration and more error details.
302
+ See all [release-it plugins on npm][42].
333
303
 
334
- Use `verbose: 2` in a configuration file to have the equivalent of `-VV` on the command line.
304
+ See [plugins][43] for documentation to write plugins.
335
305
 
336
306
  ## Use release-it programmatically
337
307
 
338
- While mostly used as a CLI tool, release-it can be used as a dependency to integrate in your own scripts. See
339
- [use release-it programmatically](./docs/recipes/programmatic.md) for example code.
308
+ While mostly used as a CLI tool, release-it can be used as a dependency to integrate in your own scripts. See [use
309
+ release-it programmatically][44] for example code.
340
310
 
341
311
  ## Example projects using release-it
342
312
 
343
- - [axios/axios](https://github.com/axios/axios)
344
- - [blockchain/blockchain-wallet-v4-frontend](https://github.com/blockchain/blockchain-wallet-v4-frontend)
345
- - [callstack/react-native-paper](https://github.com/callstack/react-native-paper)
346
- - [ember-cli/ember-cli](https://github.com/ember-cli/ember-cli)
347
- - [js-cookie/js-cookie](https://github.com/js-cookie/js-cookie)
348
- - [metalsmith/metalsmith](https://github.com/metalsmith/metalsmith)
349
- - [mozilla/readability](https://github.com/mozilla/readability)
350
- - [pahen/madge](https://github.com/pahen/madge)
351
- - [redis/node-redis](https://github.com/redis/node-redis)
352
- - [reduxjs/redux](https://github.com/reduxjs/redux)
353
- - [saleor/saleor](https://github.com/saleor/saleor)
354
- - [Semantic-Org/Semantic-UI-React](https://github.com/Semantic-Org/Semantic-UI-React)
355
- - [shipshapecode/shepherd](https://github.com/shipshapecode/shepherd)
356
- - [StevenBlack/hosts](https://github.com/StevenBlack/hosts)
357
- - [swagger-api/swagger-ui](https://github.com/swagger-api/swagger-ui) +
358
- [swagger-editor](https://github.com/swagger-api/swagger-editor)
359
- - [tabler/tabler](https://github.com/tabler/tabler) + [tabler-icons](https://github.com/tabler/tabler-icons)
360
- - [youzan/vant](https://github.com/youzan/vant)
361
- - [Repositories that depend on release-it](https://github.com/release-it/release-it/network/dependents)
362
- - GitHub search for [path:\*\*/.release-it.json](https://github.com/search?q=path%3A**%2F.release-it.json&type=code)
313
+ - [axios/axios][45]
314
+ - [blockchain/blockchain-wallet-v4-frontend][46]
315
+ - [callstack/react-native-paper][47]
316
+ - [ember-cli/ember-cli][48]
317
+ - [js-cookie/js-cookie][49]
318
+ - [metalsmith/metalsmith][50]
319
+ - [mozilla/readability][51]
320
+ - [pahen/madge][52]
321
+ - [redis/node-redis][53]
322
+ - [reduxjs/redux][54]
323
+ - [saleor/saleor][55]
324
+ - [Semantic-Org/Semantic-UI-React][56]
325
+ - [shipshapecode/shepherd][57]
326
+ - [StevenBlack/hosts][58]
327
+ - [swagger-api/swagger-ui][59] + [swagger-editor][60]
328
+ - [tabler/tabler][61] + [tabler-icons][62]
329
+ - [youzan/vant][63]
330
+ - [Repositories that depend on release-it][64]
331
+ - GitHub search for [path:\*\*/.release-it.json][65]
332
+
333
+ ## Legacy Node.js
334
+
335
+ The latest major version is v15, supporting Node.js 14 and up (as Node.js v12 is EOL). Use release-it v14 for
336
+ environments running Node.js v10 and v12. Also see [CHANGELOG.md][66].
337
+
338
+ ## Links
339
+
340
+ - See [CHANGELOG.md][66] for major/breaking updates, and [releases][67] for a detailed version history.
341
+ - To **contribute**, please read [CONTRIBUTING.md][68] first.
342
+ - Please [open an issue][69] if anything is missing or unclear in this documentation.
363
343
 
364
344
  ## License
365
345
 
366
- [MIT](./LICENSE)
346
+ [MIT][70]
347
+
348
+ [1]: #git
349
+ [2]: #hooks
350
+ [3]: #github-releases
351
+ [4]: #gitlab-releases
352
+ [5]: #changelog
353
+ [6]: #publish-to-npm
354
+ [7]: #manage-pre-releases
355
+ [8]: #plugins
356
+ [9]: ./docs/ci.md
357
+ [10]: https://github.com/release-it/release-it/actions
358
+ [11]: https://github.com/release-it/release-it/workflows/Cross-OS%20Tests/badge.svg
359
+ [12]: https://www.npmjs.com/package/release-it
360
+ [13]: https://badge.fury.io/js/release-it.svg
361
+ [14]: https://release-it.deno.dev
362
+ [15]: https://github.com/7-docs/7-docs
363
+ [16]: ./docs/npm.md#yarn
364
+ [17]: ./docs/recipes/monorepo.md
365
+ [18]: https://www.youtube.com/watch?v=7pBcuT7j_A0
366
+ [19]: https://twitter.com/KodapsAcademy
367
+ [20]: ./config/release-it.json
368
+ [21]: ./docs/configuration.md
369
+ [22]: ./docs/npm.md
370
+ [23]: https://github.com/release-it/bumper
371
+ [24]: https://github.com/release-it/conventional-changelog
372
+ [25]: https://github.com/casmith/release-it-calver-plugin
373
+ [26]: ./docs/git.md
374
+ [27]: https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases
375
+ [28]: ./docs/github-releases.md
376
+ [29]: https://docs.gitlab.com/ce/user/project/releases/
377
+ [30]: https://gitlab.com/profile/personal_access_tokens
378
+ [31]: ./docs/environment-variables.md
379
+ [32]: ./docs/gitlab-releases.md
380
+ [33]: ./docs/changelog.md
381
+ [34]: ./docs/pre-releases.md
382
+ [35]: ./docs/plugins.md#execution-order
383
+ [36]: ./docs/dry-runs.md
384
+ [37]: https://github.com/release-it/keep-a-changelog
385
+ [38]: https://github.com/release-it-plugins/lerna-changelog
386
+ [39]: https://github.com/release-it-plugins/workspaces
387
+ [40]: https://github.com/grupoboticario/news-fragments
388
+ [41]: https://github.com/j-ulrich/release-it-regex-bumper
389
+ [42]: https://www.npmjs.com/search?q=keywords:release-it-plugin
390
+ [43]: ./docs/plugins.md
391
+ [44]: ./docs/recipes/programmatic.md
392
+ [45]: https://github.com/axios/axios
393
+ [46]: https://github.com/blockchain/blockchain-wallet-v4-frontend
394
+ [47]: https://github.com/callstack/react-native-paper
395
+ [48]: https://github.com/ember-cli/ember-cli
396
+ [49]: https://github.com/js-cookie/js-cookie
397
+ [50]: https://github.com/metalsmith/metalsmith
398
+ [51]: https://github.com/mozilla/readability
399
+ [52]: https://github.com/pahen/madge
400
+ [53]: https://github.com/redis/node-redis
401
+ [54]: https://github.com/reduxjs/redux
402
+ [55]: https://github.com/saleor/saleor
403
+ [56]: https://github.com/Semantic-Org/Semantic-UI-React
404
+ [57]: https://github.com/shipshapecode/shepherd
405
+ [58]: https://github.com/StevenBlack/hosts
406
+ [59]: https://github.com/swagger-api/swagger-ui
407
+ [60]: https://github.com/swagger-api/swagger-editor
408
+ [61]: https://github.com/tabler/tabler
409
+ [62]: https://github.com/tabler/tabler-icons
410
+ [63]: https://github.com/youzan/vant
411
+ [64]: https://github.com/release-it/release-it/network/dependents
412
+ [65]: https://github.com/search?q=path%3A**%2F.release-it.json&type=code
413
+ [66]: ./CHANGELOG.md
414
+ [67]: https://github.com/release-it/release-it/releases
415
+ [68]: ./.github/CONTRIBUTING.md
416
+ [69]: https://github.com/release-it/release-it/issues/new
417
+ [70]: ./LICENSE
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "release-it",
3
- "version": "15.10.0",
4
- "description": "Generic CLI tool to automate versioning and package publishing related tasks.",
3
+ "version": "15.10.2",
4
+ "description": "Generic CLI tool to automate versioning and package publishing-related tasks.",
5
5
  "keywords": [
6
6
  "build",
7
7
  "changelog",
@@ -50,6 +50,7 @@
50
50
  "scripts": {
51
51
  "lint": "eslint lib test",
52
52
  "format": "prettier --write \"{lib,test}/**/*.js\"",
53
+ "docs": "remark README.md 'docs/**/*.md' '.github/*.md' -o",
53
54
  "test": "ava --no-worker-threads",
54
55
  "release": "./bin/release-it.js"
55
56
  },
@@ -66,9 +67,9 @@
66
67
  "cosmiconfig": "8.1.3",
67
68
  "execa": "7.1.1",
68
69
  "git-url-parse": "13.1.0",
69
- "globby": "13.1.3",
70
+ "globby": "13.1.4",
70
71
  "got": "12.6.0",
71
- "inquirer": "9.1.5",
72
+ "inquirer": "9.2.0",
72
73
  "is-ci": "3.0.1",
73
74
  "issue-parser": "6.0.0",
74
75
  "lodash": "4.17.21",
@@ -80,7 +81,7 @@
80
81
  "os-name": "5.1.0",
81
82
  "promise.allsettled": "1.0.6",
82
83
  "proxy-agent": "5.0.0",
83
- "semver": "7.3.8",
84
+ "semver": "7.5.0",
84
85
  "shelljs": "0.8.5",
85
86
  "update-notifier": "6.0.2",
86
87
  "url-join": "5.0.0",
@@ -90,19 +91,26 @@
90
91
  "devDependencies": {
91
92
  "@octokit/request-error": "3.0.3",
92
93
  "ava": "5.2.0",
93
- "eslint": "8.37.0",
94
+ "eslint": "8.39.0",
94
95
  "eslint-config-prettier": "8.8.0",
95
96
  "eslint-plugin-ava": "14.0.0",
96
97
  "eslint-plugin-import": "2.27.5",
97
98
  "eslint-plugin-prettier": "4.2.1",
98
99
  "mock-fs": "5.2.0",
99
100
  "mock-stdio": "1.0.3",
100
- "nock": "13.3.0",
101
- "prettier": "2.8.7",
102
- "sinon": "15.0.3",
101
+ "nock": "13.3.1",
102
+ "prettier": "2.8.8",
103
+ "remark-cli": "11.0.0",
104
+ "remark-preset-webpro": "0.0.2",
105
+ "sinon": "15.0.4",
103
106
  "strip-ansi": "7.0.1"
104
107
  },
105
108
  "engines": {
106
109
  "node": ">=14.9"
110
+ },
111
+ "remarkConfig": {
112
+ "plugins": [
113
+ "preset-webpro"
114
+ ]
107
115
  }
108
116
  }