# ez-release

> Release npm packages easily

Latest version **0.1.3** (published 2016-04-18) · ISC license · 0 weekly downloads

## Install

```sh
npm install ez-release
pnpm add ez-release
yarn add ez-release
bun add ez-release
```

Provides the command `ez-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.3 |
| Published | 2016-04-18 |
| First published | 2015-06-11 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.12 |
| Dependencies | 5 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Chen Yicai |
| Maintainers | dotnil |

## Links

- npm: https://www.npmjs.com/package/ez-release
- Repository: git@github.com:erzu/ez-release
- Homepage: https://github.com/erzu/ez-release
- Issues: https://github.com/erzu/ez-release/issues
- npm.io page: https://npm.io/package/ez-release

## Dependencies (5)

- [co](https://npm.io/package/co.md) ^4.5.4
- [chalk](https://npm.io/package/chalk.md) ^1.1.0
- [semver](https://npm.io/package/semver.md) ^4.3.6
- [minimist](https://npm.io/package/minimist.md) ^1.1.1
- [strftime](https://npm.io/package/strftime.md) ^0.9.2

## Recent versions

- 0.1.3 (latest) — 2016-04-18
- 0.1.2 — 2015-08-04
- 0.1.1 — 2015-08-04
- 0.1.0 — 2015-06-11

## README

# ez-release

Release npm packages easily.

`ez-release` is a command that combines common tasks about package publishments.

1. Generate changelog via `git changelog` command from [git-extras][1].
2. Update the `version` field in `package.json`.
3. Commit these two files.
4. Tag current version.
5. Push commit and tag onto remote.
6. Publish the package.

Here's the list of commands that will be executed.

```bash
$ ez-release patch --dryrun
     $ npm version patch --no-git-tag-version
     $ git changelog --tag 0.1.2
     $ git add package.json
     $ git commit -m 0.1.2
     $ git tag v0.1.2
     $ git push origin
     $ git push origin --tags
     $ npm publish
```

Running all the steps listed above manually can be tiresome and error prone.
So `ez-release` come to rescue. All you have to do is specify the new version,
whether it's a major, minor, or patch version bump. Then edit the generated
changelog. You are good to go.


## Install

```bash
$ brew install git-extras       # tested with version 3.0.0
$ npm install ez-release -g
```


## Usage

```bash
$ ez-release patch -m 'Upgrade to %s for reasons'
$ ez-release patch --dryrun             # see what commands will be executed
```

```bash
$ ez-release --help
Usage ez-release [<newversion> | patch | minor | major | prepatch | preminor | premajor | prerelease]


  Options:

    --message, -m   The message for the commit of version and changelog. If the
                    message contains %s then that will be replaced with the
                    resulting version number.

    --dryrun, -d    Test run.

```


### Specify npm

```bash
$ NPM=cnpm ez-release
```


[1]: https://github.com/tj/git-extras

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