# release-easy

> 愉快的发布npm包

Latest version **1.2.1** (published 2020-02-10) · ISC license · 0 weekly downloads

## Install

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

Provides the command `release-easy`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.1 |
| Published | 2020-02-10 |
| First published | 2019-04-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 9.3 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | 崔海峰 |
| Maintainers | haifengcui |
| Keywords | release, release-easy, easy, publish |

## Links

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

## Dependencies (5)

- [vue](https://npm.io/package/vue.md) ^2.0.0
- [execa](https://npm.io/package/execa.md) ^1.0.0
- [semver](https://npm.io/package/semver.md) ^6.0.0
- [inquirer](https://npm.io/package/inquirer.md) ^6.3.1
- [conventional-changelog](https://npm.io/package/conventional-changelog.md) ^3.1.4

## Recent versions

- 1.2.1 (latest) — 2020-02-10
- 1.1.9 — 2020-02-07
- 1.1.8 — 2020-02-06
- 1.1.7 — 2020-01-14
- 1.1.6 — 2020-01-14
- 1.1.3 — 2020-01-14
- 1.1.2 — 2019-05-09
- 1.1.1 — 2019-04-29
- 1.1.0 — 2019-04-27
- 1.0.3 — 2019-04-27
- 1.0.2 — 2019-04-27
- 1.0.1 — 2019-04-27
- 1.0.0 — 2019-04-27

## README

# 主要做哪些事情

1、语义化版本</br>
2、自动生成`changelog`</br>
3、自动发包</br>

# 怎么使用

```javascript
const release = require('release-easy')

release(options)
```

# options

类型: Object

参数 | 类型 | 默认值 | 是否必须 | 说明
---|---|---|---|---
semVerCallback|Function&#124;String|--|否|语义化版本之后要做的事情，可以传递回调函数引用，或者一个`npm scripts`指令
npmRegistry|String|https://registry.npmjs.org/|否|要发布npm的源
cwdDir|String|process.cwd()|否|自定义发布目录
syncVersionForJson|String|---|否|需要同步发布版本的package.json

# 例子

```javascript
const release = require('release-easy')

release({
  semVerCallback: 'build' // npm run build
  npmRegistry: 'https://registry.npmjs.org/'
})
```

# 也可以通过`shell`使用

```javascript
npm install -g release-easy

// 或者是
npm install --save-dev release-easy
// 通过npm script来使用
{
  "script": {
    "release": "release-easy"
  }
}
```

```
Options:
  -V, --version                 output the version number
  -c --callback <npmScript>     语义化版本之后执行的npm脚本
  -r, --registry <npmRegistry>  设置发布的npm源
  -h, --help                    output usage information
```

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