From 2eb660a7b7479aadf71ef63f3da19aeaba445d53 Mon Sep 17 00:00:00 2001 From: Connor Gray <code@connorgray.com> Date: Sat, 15 Jun 2024 14:25:42 -0700 Subject: [PATCH] release: Prep v0.1.4 for release + update CHANGELOG.md --- Cargo.toml | 2 +- README.md | 2 +- docs/CHANGELOG.md | 37 ++++++++++++++++++++++++++++++++++--- 3 files changed, 36 insertions(+), 5 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 7853a6b..ad9c57b 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "clap-markdown" -version = "0.1.3" +version = "0.1.4" authors = ["Connor Gray <code@connorgray.com>"] edition = "2021" license = "MIT OR Apache-2.0" diff --git a/README.md b/README.md index 2521854..2f08cf2 100644 --- a/README.md +++ b/README.md @@ -98,7 +98,7 @@ version number of `clap-markdown` will be changed. | `clap-markdown` | `clap` | |-----------------|-----------| -| v0.0.1 – v0.1.3 | `"4.*.*"` | +| v0.0.1 – v0.1.4 | `"4.*.*"` | ## License diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 5e9280e..3acc02f 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -8,10 +8,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [0.1.4] — 2024-06-15 + ### Added * Added `help_markdown_custom()` and `help_markdown_command_custom()`, for - customizing the built Markdown. + customizing the built Markdown using a new `MarkdownOptions` configuration + structure. + ([#25], co-authored-by [@morgante](https://github.com/morgante) + and [@keturiosakys](https://github.com/keturiosakys)) Supported customization options include: @@ -20,6 +25,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 `clap-markdown`. - Whether to show the command overview table of contents. +* Added new CI build and test action to the repository, so that new PRs will be + required automatically to pass all tests. + ([#24]) + ### Changed * `clap-markdown` will now respect the `Command.display_name` property, if set, @@ -29,6 +38,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 co-authored-by [@keturiosakys](https://github.com/keturiosakys) and [@hatchan](https://github.com/hatchan)) +* The possible values of a flag that can only either be present or absent + (true or false) will no longer be shown. + ([#22], contributed by [@ilyagr](https://github.com/ilyagr)) + +* Hidden arguments (`Arg.hide == true`) will no longer be included in the + rendered Markdown. + ([#22], contributed by [@ilyagr](https://github.com/ilyagr)) + +* Long help text for commands will now be included in the rendered output. + ([#26], contributed by [@morgante](https://github.com/morgante)) + +* Long help text for options will now be included in the rendered output. + ([#23], contributed by [@ilyagr](https://github.com/ilyagr)) + ## [0.1.3] - 2022-12-28 @@ -126,11 +149,19 @@ Initial release of `clap-markdown`. <!-- v0.1.3 --> [#11]: https://github.com/ConnorGray/clap-markdown/pull/11 -<!-- Unreleased --> +<!-- v0.1.4 --> +[#22]: https://github.com/ConnorGray/clap-markdown/pull/22 +[#23]: https://github.com/ConnorGray/clap-markdown/pull/23 +[#24]: https://github.com/ConnorGray/clap-markdown/pull/24 +[#25]: https://github.com/ConnorGray/clap-markdown/pull/25 +[#26]: https://github.com/ConnorGray/clap-markdown/pull/26 [#27]: https://github.com/ConnorGray/clap-markdown/pull/27 -[unreleased]: https://github.com/ConnorGray/clap-markdown/compare/v0.1.3...HEAD +<!-- Unreleased --> + +[Unreleased]: https://github.com/ConnorGray/clap-markdown/compare/v0.1.4...HEAD +[0.1.4]: https://github.com/ConnorGray/clap-markdown/compare/v0.1.3...v0.1.4 [0.1.3]: https://github.com/ConnorGray/clap-markdown/compare/v0.1.2...v0.1.3 [0.1.2]: https://github.com/ConnorGray/clap-markdown/compare/v0.1.1...v0.1.2 [0.1.1]: https://github.com/ConnorGray/clap-markdown/compare/v0.1.0...v0.1.1