A simple changelog parser, written in Rust.
sh
cargo install parse-changelog
You can download prebuilt binaries from the Release page. Prebuilt binaries are available for macOS, Linux (gnu and musl), and Windows.
You can install parse-changelog using Homebrew tap on macOS and Linux:
sh
brew install taiki-e/tap/parse-changelog
To use this crate as a library, add this to your Cargo.toml:
toml
[dependencies]
parse-changelog = { version = "0.4", default-features = false }
Note: When using this crate as a library, we recommend disabling the default features because the default features enable CLI-related dependencies and the library part of this crate does not use them.
Compiler support: requires rustc 1.51+
parse-changelog command parses changelog and returns a release note for the
specified version.
```text
USAGE:
parse-changelog [OPTIONS]
OPTIONS:
-t, --title Returns title instead of notes
--version-format
ARGS:
Get the release note for version 1.46.0 from Rust's release notes:
sh
curl -sSf https://raw.githubusercontent.com/rust-lang/rust/master/RELEASES.md \
| parse-changelog - 1.46.0
In Cargo's changelog,
the title starts with "Cargo ", and the patch version is omitted. This is a
format parse-changelog don't support by default, so use --prefix and
--version-format to specify a custom format. For example:
sh
curl -sSf https://raw.githubusercontent.com/rust-lang/cargo/master/CHANGELOG.md \
| parse-changelog --prefix 'Cargo ' --version-format '^\d+\.\d+$' - 1.50
--prefix is the same as [Parser::prefix_format] and --version-format is
the same as [Parser::version_format]. See documentation of those methods for
more information.
With GitHub CLI:
```sh tag=... version=...
notes=$(parse-changelog CHANGELOG.md "$version")
gh release create "$tag" --title "$version" --notes "$notes" ```
With softprops/action-gh-release GitHub Action:
```yaml name: Release
on: push: tags: - v[0-9]+.*
jobs: release: runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@v2 - name: Install parse-changelog run: cargo install parse-changelog - name: Generate Changelog run: | # Get version from github ref (remove 'refs/tags/' and prefix 'v') version="${GITHUBREF#refs/tags/v}" # Get notes for $version from CHANGELOG.md. parse-changelog CHANGELOG.md "$version" > ${{ github.workflow }}-CHANGELOG.txt - name: Release uses: softprops/action-gh-release@v1 with: bodypath: ${{ github.workflow }}-CHANGELOG.txt env: GITHUBTOKEN: ${{ secrets.GITHUBTOKEN }} ```
```rust let changelog = "\
Foo.Bar.Initial release ";
// Parse changelog. let changelog = parse_changelog::parse(changelog).unwrap();
// Get the latest release. asserteq!(changelog[0].version, "0.1.2"); asserteq!(changelog[0].title, "0.1.2 - 2020-03-01"); assert_eq!(changelog[0].notes, "- Bug fixes.");
// Get the specified release.
asserteq!(changelog["0.1.0"].title, "0.1.0 - 2020-01-01");
asserteq!(changelog["0.1.0"].notes, "Initial release");
asserteq!(changelog["0.1.1"].title, "0.1.1 - 2020-02-01");
asserteq!(
changelog["0.1.1"].notes,
"- Added Foo.\n\
- Added Bar."
);
```
See documentation for more information on
parse-changelog as a library.
By default, this crate is intended to support markdown-based changelogs that have the title of each release starts with the version format based on Semantic Versioning. (e.g., Keep a Changelog's changelog format.)
The heading for each release must be Atx-style (1-6 #) or
Setext-style (= or - in a line under text), and the heading levels
must match with other releases.
Atx-style headings:
```markdown
```
```markdown
```
Setext-style headings:
```markdown
```
```markdown
```
The title of each release must start with a text or a link text (text with
[ and ]) that starts with a valid version format. For example:
```markdown
description...
description... ```
You can also include characters before the version as prefix.
```text
^^^^^^^^ ```
By default only "v", "Version " and "Release " are allowed as prefixes and
can be customized using the [Parser::prefix_format] method
(--prefix-format option if command line).
You can freely include characters after the version (this crate does not parse it).
```text
^^^^^^^^^^^^^
```
```text
^^^^^
```
The default version format is
MAJOR.MINOR.PATCH(-PRE_RELEASE)?(+BUILD_METADATA)?, and is
based on Semantic Versioning. (Pre-release version and build
metadata are optional.)
This is parsed using the following regular expression:
text
^\d+\.\d+\.\d+(-[\w\.-]+)?(\+[\w\.-]+)?$
To customize the version format, use the [Parser::version_format] method
(--version-format option if command line).
Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.