@hugo-fixit/fixit-releaser/README.md

Versioning, change-log and release for Hugo FixIt Similar commit style

# FixIt Releaser

[![NPM version](https://img.shields.io/npm/v/@hugo-fixit/fixit-releaser.svg)](https://www.npmjs.com/package/@hugo-fixit/fixit-releaser)

中文 | [English](/README.en.md)

版本控制、变更日志和发布工具，适用于 Hugo FixIt 的类似提交风格。

## 功能

- 更新 FixIt 内部版本号。(**仅适用于 [FixIt](https://github.com/hugo-fixit/FixIt)**)
- 自动生成变更日志。（由 [auto-changelog](https://github.com/cookpete/auto-changelog) 提供支持）

## 安装

| 包管理器 | 命令                                      |
| -------- | ----------------------------------------- |
| pnpm     | `pnpm add -D @hugo-fixit/fixit-releaser`  |
| yarn     | `yarn add -D @hugo-fixit/fixit-releaser`  |
| npm      | `npm i -D @hugo-fixit/fixit-releaser`     |

## 配置

在 FixIt 项目的 `package.json` 中添加以下内容。

```json
{
  "scripts": {
    "version": "fixit-releaser version --prod",
    "release": "fixit-releaser changelog"
  }
}
```

> `fixit-releaser changelog` 配置与 auto-changelog 兼容。

## 使用方法

### 版本

将 FixIt 版本从 v0.3.12-1ca9fdb7 更新到 v0.3.12。

```bash
npx fixit-releaser version --prod
```

将 FixIt 版本从 v0.3.12-1ca9fdb7 更新到 v0.3.12-2ca9fdb7。

```bash
npx fixit-releaser version --dev
```

### 变更日志

从 v0.3.10 生成变更日志。

```bash
npx fixit-releaser changelog --starting-version v0.3.10
# auto-changelog: 6 kB written to CHANGELOG.md
```

更多用法请参见 [auto-changelog](https://github.com/cookpete/auto-changelog)。