Skip to content

Commit

Permalink
Update changelog and add announcement for major release
Browse files Browse the repository at this point in the history
  • Loading branch information
webpro committed Apr 30, 2022
1 parent 700c547 commit e2aa887
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 9 deletions.
9 changes: 5 additions & 4 deletions CHANGELOG.md
Expand Up @@ -5,28 +5,29 @@ This document lists breaking changes for each major release.
See the GitHub Releases page for detailed changelogs:
[https://github.com/release-it/release-it/releases](https://github.com/release-it/release-it/releases)

## v15
## v15 (2022-04-30)

- Removed support for Node.js v10 and v12.
- Removed support for GitLab v12.4 and lower.
- Removed anonymous metrics (and the option to disable it).
- Programmatic usage and plugins only through ES Module syntax (`import`)

Use release-it v14 in legacy environments.

## v14
## v14 (2020-09-03)

- Removed `global` property from plugins. Use `this.config[key]` instead.
- Removed deprecated `npm.access` option. Set this in `package.json` instead.

## v13
## v13 (2020-03-07)

- Dropped support for Node v8
- Dropped support for GitLab v11.6 and lower.
- Deprecated `scripts` are removed (in favor of [hooks](https://github.com/release-it/release-it#hooks)).
- Removed deprecated `--non-interactive` (`-n`) argument. Use `--ci` instead.
- Removed old `%s` and `[REV_RANGE]` syntax in command substitutions. Use `${version}` and `${latestTag}` instead.

## v12
## v12 (2019-05-03)

- The `--follow-tags` argument for `git push` has been moved to the default configuration. This is only a breaking
change if `git.pushArgs` was not empty (it was empty by default).
Expand Down
5 changes: 5 additions & 0 deletions README.md
Expand Up @@ -20,6 +20,11 @@ system, and hooks to execute any command you need to test, build, and/or publish
[![Action Status](https://github.com/release-it/release-it/workflows/Cross-OS%20Tests/badge.svg)](https://github.com/release-it/release-it/actions)
[![npm version](https://badge.fury.io/js/release-it.svg)](https://www.npmjs.com/package/release-it)

## Announcement

The latest major version is v15, supporting Node.js 14 and up (as Node.js v12 is EOL). Use release-it v14 for
environments running Node.js v10 and v12. Also see [CHANGELOG.md](./CHANGELOG.md).

## Links

- See [CHANGELOG.md](./CHANGELOG.md) for major/breaking updates, and
Expand Down
8 changes: 4 additions & 4 deletions docs/recipes/my-version.md
Expand Up @@ -4,9 +4,9 @@ This example reads a `VERSION` file, bumps it, and publishes to a package reposi
`./VERSION` file actually exists.

```javascript
const { Plugin } = require('release-it');
const fs = require('fs');
const path = require('path');
import { Plugin } from 'release-it';
import fs from 'fs';
import path from 'path';

const prompts = {
publish: {
Expand Down Expand Up @@ -59,7 +59,7 @@ class MyVersionPlugin extends Plugin {
}
}

module.exports = MyVersionPlugin;
export default MyVersionPlugin;
```

To add this plugin to a project, use this configuration:
Expand Down
2 changes: 1 addition & 1 deletion docs/recipes/programmatic.md
Expand Up @@ -3,7 +3,7 @@
From Node.js scripts, release-it can also be used as a dependency:

```js
const release = require('release-it');
import release from 'release-it';

release(options).then(output => {
console.log(output);
Expand Down

0 comments on commit e2aa887

Please sign in to comment.