parse-changelog

简单的变更日志解析器，使用 Rust 编写。

• 安装
  • 命令行界面
  • 库
• 使用（命令行界面）
• 使用（库）
• 支持格式
• 相关项目
• 许可证

安装

命令行界面

从源代码

cargo +stable install parse-changelog --locked

从预构建的二进制文件

您可以从发行页面下载预构建的二进制文件。预构建的二进制文件适用于 macOS、Linux（gnu 和 musl）和 Windows（静态可执行文件）。

# Get host target
host=$(rustc -Vv | grep host | sed 's/host: //')
# Download binary and install to $HOME/.cargo/bin
curl --proto '=https' --tlsv1.2 -fsSL https://github.com/taiki-e/parse-changelog/releases/latest/download/parse-changelog-$host.tar.gz | tar xzf - -C "$HOME/.cargo/bin"

通过 Homebrew

您可以从我们维护的 Homebrew tap 安装 parse-changelog（x86_64/aarch64 macOS、x86_64/aarch64 Linux）

brew install taiki-e/tap/parse-changelog

通过 Scoop（Windows）

您可以从我们维护的 Scoop bucket 安装 parse-changelog

scoop bucket add taiki-e https://github.com/taiki-e/scoop-bucket
scoop install parse-changelog

通过 cargo-binstall

您可以使用 cargo-binstall 安装 parse-changelog

cargo binstall parse-changelog

通过 MPR（Debian/Ubuntu）

您可以从 MPR 安装 parse-changelog

git clone 'https://mpr.makedeb.org/parse-changelog'
cd parse-changelog/
makedeb -si

通过 Prebuilt-MPR

您还可以从提供通过 APT 直接自动升级的 Prebuilt-MPR 安装 parse-changelog。首先 在您的系统上设置 Prebuilt-MPR，然后运行以下命令

sudo apt install parse-changelog

注意：MPR/Prebuilt-MPR 软件包由社区维护，而不是 parse-changelog 的维护者。

在 GitHub Actions 上

您可以使用 taiki-e/install-action 在 Linux、macOS 和 Windows 上安装预构建的二进制文件。这使得安装更快，并可能避免上游更改导致的 问题。

- uses: taiki-e/install-action@parse-changelog

库

要将此软件包用作库，请在您的 Cargo.toml 中添加以下内容

[dependencies]
parse-changelog = { version = "0.6", default-features = false }

注意：当将此软件包用作库时，我们建议禁用默认功能，因为默认功能启用了与 CLI 相关的依赖项，而此软件包的库部分不使用它们。

使用（命令行界面）

parse-changelog 命令解析变更日志并为指定的版本返回发布说明。

$ parse-changelog --help
parse-changelog

Simple changelog parser, written in Rust.

Parses changelog and returns a release note for the specified version.

USAGE:
    parse-changelog [OPTIONS] <PATH> [VERSION]

ARGS:
    <PATH>       Path to the changelog file (use '-' for standard input)
    [VERSION]    Specify version (by default, select the latest release)

OPTIONS:
    -t, --title                       Returns title instead of notes
        --title-no-link               Similar to --title, but remove links from title
        --json                        Returns JSON representation of all releases in changelog
        --version-format <PATTERN>    Specify version format
        --prefix-format <PATTERN>     Specify prefix format [aliases: prefix]
    -h, --help                        Print help information
    -V, --version                     Print version information

示例：获取 Rust 的发布说明

从Rust的发布说明获取版本1.46.0的发布说明。

curl -fsSL https://raw.githubusercontent.com/rust-lang/rust/master/RELEASES.md \
  | parse-changelog - 1.46.0

上述命令的输出。

示例：获取Cargo的变更日志

在Cargo的变更日志中，标题以"Cargo "开头，省略了补丁版本。这是parse-changelog默认不支持的一种格式，因此请使用--prefix和--version-format来指定自定义格式。例如

curl -fsSL https://raw.githubusercontent.com/rust-lang/cargo/master/CHANGELOG.md \
  | parse-changelog --prefix 'Cargo ' --version-format '^[0-9]+\.[0-9]+$' - 1.50

上述命令的输出。

--prefix等同于Parser::prefix_format，而--version-format等同于Parser::version_format。有关更多信息，请参阅这些方法的文档。

示例：从变更日志创建新的GitHub发布

使用GitHub CLI

tag=...
version=...

# Get notes for $version from CHANGELOG.md.
notes=$(parse-changelog CHANGELOG.md "$version")
# Create a new GitHub release with GitHub CLI.
gh release create "$tag" --title "$version" --notes "$notes"

另请参阅create-gh-release-action。

使用（库）

let changelog = "\
## 0.1.2 - 2020-03-01

- Bug fixes.

## 0.1.1 - 2020-02-01

- Added `Foo`.
- Added `Bar`.

## 0.1.0 - 2020-01-01

Initial release
";

// Parse changelog.
let changelog = parse_changelog::parse(changelog).unwrap();

// Get the latest release.
assert_eq!(changelog[0].version, "0.1.2");
assert_eq!(changelog[0].title, "0.1.2 - 2020-03-01");
assert_eq!(changelog[0].notes, "- Bug fixes.");

// Get the specified release.
assert_eq!(changelog["0.1.0"].title, "0.1.0 - 2020-01-01");
assert_eq!(changelog["0.1.0"].notes, "Initial release");
assert_eq!(changelog["0.1.1"].title, "0.1.1 - 2020-02-01");
assert_eq!(
    changelog["0.1.1"].notes,
    "- Added `Foo`.\n\
     - Added `Bar`."
);

有关parse-changelog作为库的更多信息，请参阅文档。

支持格式

默认情况下，这个crate旨在支持以markdown为基础的变更日志，其中每个发布的标题都以基于语义化版本控制的版本格式开头。（例如，Keep a Changelog的变更日志格式。）

标题

每个发布的标题必须是Atx样式（1-6个#）或Setext样式（文本下的一行中包含=或-），并且标题级别必须与其他发布匹配。

# 0.1.0

## 0.1.0

0.1.0
=====

0.1.0
-----

# [0.2.0]

description...

# 0.1.0

description...

## Version 0.1.0
   ^^^^^^^^

## v0.1.0 -- 2020-01-01
    ^^^^^

^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(-[0-9A-Za-z\.-]+)?(\+[0-9A-Za-z\.-]+)?$|^Unreleased$

# 0.1.0 - 2020-01-01
       ^^^^^^^^^^^^^