changelogging

从片段构建变更日志。

安装

可以从 发布版 下载二进制文件。

pipx

注意：因为 changelogging 最初是用 Python 编写的，PyPI 上的发布版本有不同的版本号：例如，版本 0.4.4 在 PyPI 上的版本是 2.4.4，这意味着版本号的主部分总是增加两次以获得 PyPI 版本。

使用 pipx 安装 changelogging 非常简单

$ pipx install changelogging

或者，可以从源代码安装该软件包

$ pipx install git+https://github.com/nekitdev/changelogging.git

或者通过克隆仓库

$ git clone https://github.com/nekitdev/changelogging.git
$ cd changelogging
$ pipx install .

cargo

使用 cargo 安装软件包与使用 pipx 一样简单

$ cargo install changelogging

或者，可以从源代码安装该软件包

$ cargo install --git https://github.com/nekitdev/changelogging.git

或者通过克隆仓库

$ git clone https://github.com/nekitdev/changelogging.git
$ cd changelogging
$ cargo install --path .

示例

安装 changelogging 后，我们可以开始构建变更日志！

首先，我们需要配置项目的 上下文。

创建 changelogging.toml 并添加项目的 名称、版本 和 URL

[context]
name = "changelogging"
version = "0.4.4"
url = "https://github.com/nekitdev/changelogging"

然后我们需要创建 changes 目录。

$ mkdir changes

现在我们可以添加 片段

$ changelogging create --content "Added cool features!" 13.feature.md
$ changelogging create --content "Fixed annoying bugs!" 64.fix.md

最后，预览变更日志条目！

$ changelogging preview
## 0.4.4 (YYYY-MM-DD)

### Features

- Added cool features! (#13)

### Fixes

- Fixed annoying bugs! (#64)

然后让我们添加以下内容的 CHANGELOG.md 文件

# Changelog

<!-- changelogging: start -->

注意，如果我们要在变更日志条目前添加一些内容，则 start 是必需的。

假设预览是我们期望的样子，将其写入变更日志就像这样简单

$ changelogging build

最后，让我们看看变更日志

$ cat CHANGELOG.md
# Changelog

<!-- changelogging: start -->

## 0.4.4 (YYYY-MM-DD)

### Features

- Added cool features! (#13)

### Fixes

- Fixed annoying bugs! (#64)

文档

您可以在 这里 找到文档。

支持

如果您需要对该库的支持，您可以发送 电子邮件 或参考官方的 Discord 服务器。

变更日志

您可以在 这里 找到变更日志。

安全策略

您可以在以下链接找到changelogging的安全策略：这里。

贡献

如果您想为changelogging做出贡献，请务必查看贡献指南，以及行为准则。

许可证

changelogging遵循MIT许可证。有关详细信息，请参阅许可证。