From 1ca68cd764c3c01dfef507adb1eeb615f9147404 Mon Sep 17 00:00:00 2001 From: Martin Geisler Date: Sat, 13 Feb 2021 17:05:00 +0100 Subject: [PATCH 1/5] Remove triple-quoted string in Cargo.toml The `thomaseizinger/set-crate-version` GitHub action does not support such strings. --- Cargo.toml | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 8dbad37..f97d586 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -2,10 +2,7 @@ name = "version-sync" version = "0.9.1" authors = ["Martin Geisler "] -description = """ -Simple crate for ensuring that version numbers in README files are -updated when the crate version changes. -""" +description = "Crate for ensuring that version numbers in README files and other files are kept in sync with the crate version." documentation = "https://docs.rs/version-sync/" repository = "https://github.com/mgeisler/version-sync" readme = "README.md" From 9b6ee820afe6c6cd32c9426554e98552e890fc71 Mon Sep 17 00:00:00 2001 From: Martin Geisler Date: Sat, 13 Feb 2021 17:13:30 +0100 Subject: [PATCH 2/5] Fix changelog heading format to match existing entries --- .github/workflows/prepare-release.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/prepare-release.yml b/.github/workflows/prepare-release.yml index d411065..9baf523 100644 --- a/.github/workflows/prepare-release.yml +++ b/.github/workflows/prepare-release.yml @@ -82,7 +82,7 @@ jobs: var content = fs.readFileSync('README.md', 'utf8') const today = new Date().toISOString().split('T')[0] - const heading = `### Version ${new_version} (${today})\n` + const heading = `### Version ${new_version} — ${today}\n` if (content.match('### Unreleased')) { content = content.replace('### Unreleased', `${heading}\n${changelog}`) } else { From 009d232ecda23c996bf38078e70145cc32eba9e3 Mon Sep 17 00:00:00 2001 From: Martin Geisler Date: Sat, 13 Feb 2021 17:27:06 +0100 Subject: [PATCH 3/5] Rename example crate in README example This is to avoid accidentally bumping its version when making new releases of version-sync. --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 2a1240f..f4a3905 100644 --- a/README.md +++ b/README.md @@ -49,10 +49,11 @@ test result: ok. 2 passed; 0 failed; 0 ignored; 0 measured ``` If the README or `html_root_url` is out of sync with the crate -version, the tests fail. In this example, the version number in -`Cargo.toml` has been changed to 0.2.0 while the `README.md` and -`html_root_url` remain unchanged. The tests now fail and the -problematic TOML code and attribute are shown: +version, the tests fail. In this example, the crate is called +`your-crate` and the version number in `Cargo.toml` has been changed +to 0.2.0 while the `README.md` and `html_root_url` still use 0.1.2. +The tests now fail and the problematic TOML code and attribute are +shown: ``` $ cargo test @@ -69,7 +70,7 @@ failures: Checking code blocks in README.md... README.md (line 20) ... expected minor version 2, found 1 in [dev-dependencies] - version-sync = "0.1" + your-crate = "0.1" thread 'test_readme_deps' panicked at 'dependency errors in README.md', tests/version-numbers.rs:6 note: Run with `RUST_BACKTRACE=1` for a backtrace. @@ -77,7 +78,7 @@ note: Run with `RUST_BACKTRACE=1` for a backtrace. ---- test_html_root_url stdout ---- Checking doc attributes in src/lib.rs... src/lib.rs ... expected minor version 2, found 1 in - #![doc(html_root_url = "https://docs.rs/version-sync/0.1.3")] + #![doc(html_root_url = "https://docs.rs/your-crate/0.1.2")] thread 'test_html_root_url' panicked at 'html_root_url errors in src/lib.rs', tests/version-numbers.rs:11 From aac8fb300c3750599ba07b495208777a94b25d8c Mon Sep 17 00:00:00 2001 From: Martin Geisler Date: Sat, 13 Feb 2021 16:19:47 +0000 Subject: [PATCH 4/5] Update changelog for version 0.9.2 --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index f4a3905..c98d9c6 100644 --- a/README.md +++ b/README.md @@ -108,6 +108,17 @@ your_crate = "0.1.2" This is a changelog describing the most important changes per release. +### Version 0.9.2 — 2021-02-13 + +* [#94](https://github.com/mgeisler/version-sync/pull/94): chore: + Update pulldown-cmark to 0.8. +* [#95](https://github.com/mgeisler/version-sync/pull/95): Fix + `non_fmt_panic` lint error in latest nightly. +* [#100](https://github.com/mgeisler/version-sync/pull/100): Setup + weekly build to catch errors on nightly Rust. +* [#101](https://github.com/mgeisler/version-sync/pull/101): Forbid + warnings when building in CI. + ### Version 0.9.1 — 2020-07-07 * [#91](https://github.com/mgeisler/version-sync/pull/91): Pull in From 4e7a4c5a74c7c8c1f0816a816d2be4a563fdcd24 Mon Sep 17 00:00:00 2001 From: Martin Geisler Date: Sat, 13 Feb 2021 16:21:03 +0000 Subject: [PATCH 5/5] Bump version to 0.9.2 --- Cargo.toml | 2 +- src/lib.rs | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index f97d586..321bb62 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "version-sync" -version = "0.9.1" +version = "0.9.2" authors = ["Martin Geisler "] description = "Crate for ensuring that version numbers in README files and other files are kept in sync with the crate version." documentation = "https://docs.rs/version-sync/" diff --git a/src/lib.rs b/src/lib.rs index 74d4091..42a8909 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -46,7 +46,7 @@ //! [`assert_html_root_url_updated`]: macro.assert_html_root_url_updated.html //! [`assert_contains_regex`]: macro.assert_contains_regex.html -#![doc(html_root_url = "https://docs.rs/version-sync/0.9.1")] +#![doc(html_root_url = "https://docs.rs/version-sync/0.9.2")] #![deny(missing_docs)] mod contains_regex;