# @auto-it/released

> Released plugin for auto. Comments with version + extra

Latest version **11.3.6** (published 2025-11-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install @auto-it/released
pnpm add @auto-it/released
yarn add @auto-it/released
bun add @auto-it/released
```

## Health

**Score 55/100 (C)** — status: stable.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 11.3.6 |
| Published | 2025-11-14 |
| First published | 2019-05-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 20.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2494 |
| Author | Andrew Lisowski |
| Maintainers | alisowski |
| Keywords | automation, semantic, release, github, labels, automated, continuos integration, changelog, released, comment |

## Links

- npm: https://www.npmjs.com/package/@auto-it/released
- Repository: https://github.com/intuit/auto
- Homepage: https://github.com/intuit/auto#readme
- Issues: https://github.com/intuit/auto/issues
- npm.io page: https://npm.io/package/@auto-it/released

## Dependencies (6)

- [fp-ts](https://npm.io/package/fp-ts.md) ^2.5.3
- [io-ts](https://npm.io/package/io-ts.md) ^2.1.2
- [tslib](https://npm.io/package/tslib.md) 2.1.0
- [deepmerge](https://npm.io/package/deepmerge.md) ^4.0.0
- [@auto-it/core](https://npm.io/package/@auto-it/core.md) 11.3.6
- [@auto-it/bot-list](https://npm.io/package/@auto-it/bot-list.md) 11.3.6

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 11.3.6 (latest) — 2025-11-14
- 10.0.0-next.3 (next) — 2020-10-28
- 9.9.2-canary.1.06e1a137.0 (canary) — 2020-02-06
- 8.5.0 (version-branches) — 2019-12-17
- 11.3.5 — 2025-11-14
- 11.3.4 — 2025-11-14
- 11.3.3 — 2025-11-14
- 11.3.2 — 2025-11-14
- 11.3.0 — 2024-10-25
- 11.2.1 — 2024-08-28
- 11.2.0 — 2024-07-17
- 11.1.6 — 2024-04-04
- 11.1.5 — 2024-04-04
- 11.1.4 — 2024-04-04
- 11.1.3 — 2024-04-03
- … 964 more at https://npm.io/package/@auto-it/released/versions

## README

# Released Plugin

This plugin

- comments on the merged PR with the new version
- comments on closed issues with the new version
- adds a `released` label to the pull request
- adds a `released` label to closed issues

> :warning: Make sure that you create the `released` label on you project

## Installation

This plugin is included with the `auto` CLI so you do not have to install it. To install if you are using the `auto` API directly:

```bash
npm i --save-dev @auto-it/released
# or
yarn add -D @auto-it/released
```

## Usage

To use the plugin include it in your `.autorc`

```json
{
  "plugins": ["released"]
}
```

## Options

### Label

Customize the label this plugin attaches to merged pull requests.

```json
{
  "plugins": [
    [
      "released",
      {
        "label": ":shipit:"
      }
    ]
  ]
}
```

### Prerelease Label

Customize the prerelease label this plugin attaches to pull requests merged to prerelease branches.

```json
{
  "plugins": [
    [
      "released",
      {
        "prereleaseLabel": "🚧"
      }
    ]
  ]
}
```

### Message

To customize the message this plugin uses on issues and pull requests use the following format.

- `%TYPE` - Either `PR` or `Issue`
- `%VERSION` - The version that was just published

```json
{
  "plugins": [
    [
      "released",
      {
        "message": "%TYPE went out with version: %VERSION"
      }
    ]
  ]
}
```

### Lock Issue

Lock issues that have been merged in PRs.

```json
{
  "plugins": [["released", { "lockIssues": true }]]
}
```

### Include Bot Prs

Whether to comment on PRs made by bots.

```json
{
  "plugins": [["released", { "includeBotPrs": true }]]
}
```

---
_Source: https://npm.io/package/@auto-it/released · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._