# publish-version

> A CLI to automate versioning and package publishing tasks

Latest version **0.1.3** (published 2021-07-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install publish-version
pnpm add publish-version
yarn add publish-version
bun add publish-version
```

Provides the command `publish-version`.

## 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 | 2021-07-28 |
| First published | 2021-06-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 14 |
| Unpacked size | 149.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | kzf |
| Maintainers | kezhongfa |
| Keywords | publish, version, release, changelog |

## Links

- npm: https://www.npmjs.com/package/publish-version
- Repository: https://github.com/kezhongfa/publish-version
- Homepage: https://github.com/kezhongfa/publish-version#readme
- Issues: https://github.com/kezhongfa/publish-version/issues
- npm.io page: https://npm.io/package/publish-version

## Dependencies (14)

- [ora](https://npm.io/package/ora.md) ^5.4.1
- [yaml](https://npm.io/package/yaml.md) ^1.10.2
- [chalk](https://npm.io/package/chalk.md) ^4.1.1
- [debug](https://npm.io/package/debug.md) ^4.3.1
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [rimraf](https://npm.io/package/rimraf.md) ^3.0.2
- [semver](https://npm.io/package/semver.md) ^7.3.5
- [shelljs](https://npm.io/package/shelljs.md) ^0.8.4
- [inquirer](https://npm.io/package/inquirer.md) ^8.1.1
- [minimist](https://npm.io/package/minimist.md) ^1.2.5
- [parse-json](https://npm.io/package/parse-json.md) ^5.2.0
- [cosmiconfig](https://npm.io/package/cosmiconfig.md) ^7.0.0
- [git-url-parse](https://npm.io/package/git-url-parse.md) ^11.5.0
- [update-notifier](https://npm.io/package/update-notifier.md) ^5.1.0

## 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

- 0.1.3 (latest) — 2021-07-28
- 0.0.5-alpha.1 (alpha) — 2021-07-23
- 0.0.5-beta.0 (beta) — 2021-07-23
- 0.1.2 — 2021-07-28
- 0.1.1 — 2021-07-27
- 0.0.7 — 2021-07-24
- 0.0.6 — 2021-07-24
- 0.0.5 — 2021-07-23
- 0.0.4 — 2021-07-23
- 0.0.5-alpha.0 — 2021-07-23
- 0.0.4-alpha.0 — 2021-07-23
- 0.0.3 — 2021-07-16
- 0.0.2 — 2021-06-08
- 0.0.1 — 2021-06-08

## README

# publish-version

- 用于自动执行版本控制和包发布任务的 CLI。

- 严格遵循 [Semantic Versioning](http://semver.org/lang/zh-CN/) 语义化版本规范。

## 安装

项目内安装

```bash
npm install publish-version -D

```

```js
{
  ...
  "scripts": {
    "release": "publish-version"
  },
  "devDependencies": {
    "publish-version": "*"
  }
  ...
}
```

全局安装

```bash
npm install publish-version -g
npx publish-version // 使用
npx publish-version --help // 显示帮助
```

## 使用

### release(发版)

根据提示选择

```bash
publish-version
publish-version --preRelease  // beta版本选择
publish-version --preRelease=rc // rc版本选择

```

指定版本(如果此时版本为 0.0.1)

```bash
publish-version patch // 0.0.2
publish-version minor // 0.1.0
publish-version major // 1.0.0
publish-version 1.1.0 // 1.1.0

```

指定版本(如果此时版本为 0.0.1)

```bash
publish-version major --preRelease=beta // 1.0.0-beta.0
publish-version premajor --preReleaseId=beta --npm.tag=beta // 1.0.0-beta.0

```

### 发布私有的包

1. 如果你在 package.json 中设置了 "private": true，那么 npm 将拒绝发布它
2. @npm/package-name 这种形式的包名，是有作用域的包名形式，执行 npm publish 的时候默认是发布私有的包。

这是一种防止意外发布私有存储库的方法。如果您想发布私有的包(优先级:scripts>自定义配置>package.json)

scripts

```js
{
  ...
  "scripts": {
    "release": "publish-version --npm.access=public"
  }
  ...
}
```

自定义配置

```js
{
"npm": {
    "access": "public"
  }
}
```

package.json

```json
 "publishConfig": {
    "access": "public"
  }
```

### no publish(不发布)

```bash
publish-version --no-npm.skipCheck // no check(eg:用户是否是包合作者,用户是否登录,registry是否可用等)
publish-version --no-npm.publish  // no publish
publish-version --no-npm // no check,publish

```

### no git project(非 git 项目) 或 no check,commit,push(git 不检查,提交,推送)

```bash
publish-version --no-git.skipCheck // no check(eg:是否是git仓库,是否是指定分支,是否工作区干净等)
publish-version --no-git.commit  // no commit
publish-version --no-git.push // no push
publish-version --no-git // no check,commit,push

```

### no update version(不更新版本)

```bash
publish-version --no-increment

```

### changelog

自定义配置

```js
{
"git": {
    "changelog": "npx auto-changelog --commit-limit false" //or npx conventional-changelog-cli -p angular -i CHANGELOG.md -s -r 0
  },
  "hooks": {
      "afterVersion": "npx auto-changelog -p" //or npx conventional-changelog-cli -p angular -i CHANGELOG.md -s
    }
}
```

### only changelog(仅更新 changelog)

```bash
publish-version --only-changelog
```

自定义配置

```js
{
"git": {
    "changelog": "npx auto-changelog --commit-limit false" //or npx conventional-changelog-cli -p angular -i CHANGELOG.md -s -r 0
  }
}
```

## 默认值配置

项目有[默认配置](./src/config/publish-version.json)

我们可以通过设置,覆盖默认配置

- 项目根目录下(优先级:package.json>.publish-version.json>.publish-version.js)
- 也可指定配置文件`--config path/publish-version.json`

```js
{
"git": {
    "skipCheck": true
  },
  "npm": {
    "publishPath": "dist"
  }
}
```

## 变量(运行中提供的变量)

```js
version;
latestVersion;
name;
repo.remote, repo.protocol, repo.host, repo.owner, repo.repository, repo.project;
```

## hooks(运行过程中提供的钩子)

| 名称          |            含义 |
| :------------ | --------------: |
| beforeStart   |  npm,git 检查前 |
| afterStart    |  npm,git 检查后 |
| beforeVersion | 更新 version 前 |
| afterVersion  | 更新 version 后 |
| beforePublish |      publish 前 |
| afterPublish  |      publish 后 |

```js
{
  "hooks": {
    "beforeStart": "npm run codecheck",
    "afterStart": "echo afterStart",
    "beforeVersion": "echo ${name} current version ${latestVersion}",
    "afterVersion": "npx auto-changelog -p",
 "beforePublish": "echo before publish ${name} v${version}.",
    "afterPublish": "echo after publish ${name} v${version} to ${repo.repository}."
  }
}
```

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