# nitro-release

> A release package for nitro. Manage your releases with ease.

Latest version **0.1.1** (published 2017-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install nitro-release
pnpm add nitro-release
yarn add nitro-release
bun add nitro-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.1 |
| Published | 2017-11-07 |
| First published | 2016-07-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Christian Stuff |
| Maintainers | regaddi, namicsorg, ernscht |
| Keywords | nitro, release |

## Links

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

## Dependencies (3)

- [yargs](https://npm.io/package/yargs.md) 10.0.3
- [gulp-git](https://npm.io/package/gulp-git.md) 2.4.2
- [gulp-bump](https://npm.io/package/gulp-bump.md) 2.8.0

## Recent versions

- 0.1.1 (latest) — 2017-11-07
- 0.1.0 — 2016-08-03
- 0.0.1 — 2016-07-25

## README

# nitro-release

With this package, Nitro can produce releases by using `gulp release` on the CLI.
You can influence the version bump by using the `--bump` option.

All possibilities in examples:

    $ gulp release --bump
    \> Version bumped from 0.0.0 -> 0.0.1

    $ gulp release --bump=minor
    \> Version bumped from 0.0.1 -> 0.1.0

    $ gulp release --bump=major
    \> Version bumped from 0.1.0 -> 1.0.0

    $ gulp release --bump=patch
    \> Version bumped from 1.0.0 -> 1.0.1

The release configuration can be found in [config.json](//github.com/namics/generator-nitro/app/templates/config.json).

## Configuration options

### release.bumpFiles (Array)

A list of files, where a version bump should be processed.

- example: `["package.json"]`

### release.commit (Boolean)

Defines, if the `bumpFiles` should be committed. A commit will have the message `Release VERSION`.

- example: `false`

### release.commitMessage (String)

Defines the commit message. Use `%VERSION%` to replace with current (bumped) version.

- example: `"Release %VERSION%"`

### release.push (Boolean)

Defines, if a commit should be pushed automatically. Only pushes, if `commit` is set to `true`.

- example: `false`

### release.pushBranch (String)

Defines the branch, which should be pushed. This should be the name of the branch, where the release happens.

- example: `"master"`

### release.pushTo (String)

Defines the remote origin name.

- example: `"origin"`

### release.tag (Boolean)

Defines, if a release git tag should be created. The name is `vVERSION`, e.g. `v0.1.0`.

- example: `false`

### release.tagName (String)

Defines the tag name. Use `%VERSION%` to replace with current (bumped) version.

- example: `"v%VERSION%"`

## Example Release Config

```
"release": {
    "bumpFiles": ["package.json"],
    "commit": false,
    "push": false,
    "pushBranch": "master",
    "pushTo": "origin",
    "tag": false
}
```

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