# semantic-release-notes

> like semantic-release but specific to generate release notes between two tags

Latest version **1.0.6** (published 2022-09-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install semantic-release-notes
pnpm add semantic-release-notes
yarn add semantic-release-notes
bun add semantic-release-notes
```

Provides the command `semantic-release-notes`.

## Health

**Score 5/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: insecure dependencies; abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2022-09-26 |
| First published | 2022-06-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=16 \|\| ^14.17 |
| Dependencies | 18 |
| Unpacked size | 31.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Vincent Fischer |
| Maintainers | vincentfischer |
| Keywords | semantic-release, semantic-version, semver, release-notes |

## Links

- npm: https://www.npmjs.com/package/semantic-release-notes
- Repository: https://github.com/fischervincent/semantic-release-notes
- Homepage: https://github.com/fischervincent/semantic-release-notes#readme
- Issues: https://github.com/fischervincent/semantic-release-notes/issues
- npm.io page: https://npm.io/package/semantic-release-notes

## Dependencies (18)

- [execa](https://npm.io/package/execa.md) ^5.0.0
- [yargs](https://npm.io/package/yargs.md) ^16.2.0
- [env-ci](https://npm.io/package/env-ci.md) ^7.1.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [semver](https://npm.io/package/semver.md) ^7.3.2
- [hook-std](https://npm.io/package/hook-std.md) ^2.0.0
- [p-reduce](https://npm.io/package/p-reduce.md) ^2.0.0
- [url-join](https://npm.io/package/url-join.md) ^4.0.0
- [get-stream](https://npm.io/package/get-stream.md) ^6.0.1
- [cosmiconfig](https://npm.io/package/cosmiconfig.md) ^7.0.1
- [read-pkg-up](https://npm.io/package/read-pkg-up.md) ^7.0.0
- [semver-diff](https://npm.io/package/semver-diff.md) ^3.1.1
- [resolve-from](https://npm.io/package/resolve-from.md) ^5.0.0
- [find-versions](https://npm.io/package/find-versions.md) ^4.0.0
- [git-log-parser](https://npm.io/package/git-log-parser.md) ^1.2.0
- [aggregate-error](https://npm.io/package/aggregate-error.md) ^3.0.0
- [@semantic-release/commit-analyzer](https://npm.io/package/@semantic-release/commit-analyzer.md) ^9.0.2
- [@semantic-release/release-notes-generator](https://npm.io/package/@semantic-release/release-notes-generator.md) github:semantic-release/release-notes-generator

## Recent versions

- 1.0.6 (latest) — 2022-09-26
- 1.0.5 — 2022-09-26
- 1.0.4 — 2022-09-26
- 1.0.3 — 2022-06-20
- 1.0.2 — 2022-06-20
- 1.0.1 — 2022-06-17
- 1.0.0 — 2022-06-17
- 0.1.2 — 2022-06-16
- 0.1.1 — 2022-06-16
- 0.0.1 — 2022-06-16

## README

# semantic-release-notes

This package allows you to generate a release notes when you already have created the tag. For example you already created a new version that you tested in QA, maybe 2 because it needed a fix before deploying to prod, and you are going to push in PROD to deploy.
This package is like [**semantic-release**](https://github.com/semantic-release/semantic-release) but without the publishing, and it selects the last local tag as the next release, and the last remote tag as the last release.

## Install

Add the plugin to your npm-project:

```bash
$ npm install semantic-release-notes -D
```

## Configuration

This plugin has to be configured in the [**semantic-release** configuration file](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration). Not every features of **semantic-release** are supported.
Example:

```json 
{
  "plugins": [
    "@semantic-release/commit-analyzer",
    "@semantic-release/release-notes-generator",
    [
      "semantic-release-discord",
      {
        "notifyOnSuccess": true,
        "notifyOnFail": true,
        "discordWebhookId": "ID",
        "discordWebhookToken": "AAAA",
      }
    ]
  ]
}
```

### Options

| Option          | Description                                                                                                         | Default   |
| :-------------- | :------------------------------------------------------------------------------------------------------------------ | :-------- |
| `isAzureDevOps` | If true, rewrite the commits message so that it is correctly parsed by release-notes-generator.                     | false     |
| `azureWorkItem` | Path to azure work items. If defined and isAzureDevOps is true, it inserts the work item link to the commit message |           |

---
_Source: https://npm.io/package/semantic-release-notes · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._