Merge pull request #5230 from epage/migrate

docs: Link out to the changelog at the relevant tag
clap-rs · Nov 28, 2023 · 91bcac4 · 91bcac4
2 parents b661a9d + 030d875
commit 91bcac4
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -62,6 +62,7 @@ pre-release-replacements = [
   {file="CHANGELOG.md", search="<!-- next-url -->", replace="<!-- next-url -->\n[Unreleased]: https://github.com/clap-rs/clap/compare/{{tag_name}}...HEAD", exactly=1},
   {file="CITATION.cff", search="^date-released: ....-..-..", replace="date-released: {{date}}"},
   {file="CITATION.cff", search="^version: .+\\..+\\..+", replace="version: {{version}}"},
+  {file="src/lib.rs", search="blob/v.+\\..+\\..+/CHANGELOG.md", replace="blob/v{{version}}/CHANGELOG.md", exactly=1},
 ]
 
 [features]

diff --git a/src/lib.rs b/src/lib.rs
@@ -11,6 +11,8 @@
 //! - [Cookbook][_cookbook]
 //! - [FAQ][_faq]
 //! - [Discussions](https://github.com/clap-rs/clap/discussions)
+//! - [CHANGELOG](https://github.com/clap-rs/clap/blob/v4.4.9/CHANGELOG.md) (includes major version migration
+//!   guides)
 //!
 //! ## Aspirations
 //!