Skip to content

Commit

Permalink
Merge pull request #105 from mgeisler/release-0.9.2
Browse files Browse the repository at this point in the history
Release 0.9.2
  • Loading branch information
mgeisler authored Feb 13, 2021
2 parents 563056d + 4e7a4c5 commit 7891516
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 13 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/prepare-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
7 changes: 2 additions & 5 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
[package]
name = "version-sync"
version = "0.9.1"
version = "0.9.2"
authors = ["Martin Geisler <[email protected]>"]
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"
Expand Down
24 changes: 18 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -69,15 +70,15 @@ 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.
---- 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
Expand Down Expand Up @@ -107,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
Expand Down
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down

0 comments on commit 7891516

Please sign in to comment.