# nx-semantic-release

> Semantic release plugin for nx workspaces

Latest version **0.1.2** (published 2020-01-27) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2020-01-27 |
| First published | 2020-01-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10.13 |
| Dependencies | 0 |
| Unpacked size | 11 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Austin R English |
| Maintainers | arenglish |
| Keywords | nx, monorepo, semantic-release, semantic, versioning, release, plugin |

## Links

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

## Recent versions

- 0.1.2 (latest) — 2020-01-27
- 0.1.1 — 2020-01-26
- 0.1.0 — 2020-01-26

## README

# nx-semantic-release

[**semantic-release**](https://github.com/semantic-release/semantic-release) plugin to
prepare workspace apps using nx's affected:<target> tool.

[![CircleCI](https://circleci.com/gh/arenglish/nx-semantic-release/tree/master.svg?style=svg)](https://circleci.com/gh/arenglish/nx-semantic-release/tree/master)

[![npm latest version](https://img.shields.io/npm/v/nx-semantic-release/latest.svg)](https://www.npmjs.com/package/nx-semantic-release)

| Step               | Description                                                                                                                                                                                                                              |
|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `prepare`          | Run nx affected over desired targets before publishing.                                                                                                                        |

## Install

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

## Usage

The plugin can be configured in the [**semantic-release** configuration file](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration):

```json
{
  "plugins": [
    "@semantic-release/commit-analyzer",
    "@semantic-release/release-notes-generator",
    "nx-semantic-release"
  ]
}
```


### Options

| Option                | Description                                                                                                                                                                                            | Default                                                                                                                                              |
|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
| `targets`                | An array of targets to run nx affected:<target> against.                                                                                                                                            | []                                                                                                     |
| `projects`                | An array of projects to whitelist.                                                                                                                                                                 | [] (if empty, will run against any affected projects)                                                                                                   |
| `customCommands`        | Array of additional commands to run on affected projects (command will be passed a $project variable)                                                                                                | []                                                                                         |
| `extraArgs`        | Additional arguments to pass to the affected:<target> commands                                                                                                                  | []                                                                                                     |


## Detailed Usage
The plugin can be configured in the [**semantic-release** configuration file](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration):

```json
{
  "plugins": [
    "@semantic-release/commit-analyzer",
    "@semantic-release/release-notes-generator",
    [
      "nx-semantic-release",
      {
        "targets": ["build"],
        "extraArgs": ["--prod", "--stats-json"],
        "customCommands": ["npm run genBundleReports -- --$project"]
      }
    ]
  ]
}
```

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