check-versions 0.1.1

Simple crate for ensuring that version numbers in README files are updated when the crate version changes.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

# check-versions

[![](https://img.shields.io/crates/v/check-versions.svg)][crates-io]
[![](https://docs.rs/check-versions/badge.svg)][api-docs]
[![](https://travis-ci.org/mgeisler/check-versions.svg?branch=master)][travis-ci]
[![](https://ci.appveyor.com/api/projects/status/hy8camtdx5iiq26l?svg=true)][appveyor]

The `check-versions` crate is a simple crate that will help you
remember to update the versions numbers in your `README.md` file.

## Usage

Add this to your `Cargo.toml`:
```toml
[dev-dependencies]
check-versions = "0.1"
```

Then create a `tests/check-versions.rs` with:
```rust
#[macro_use]
extern crate check_versions;

#[test]
fn test_readme_deps() {
    assert_markdown_deps_updated!("README.md");
}
```

This test will ensure that the dependencies mentioned in your
`README.md` file is kept in sync with your crate version:
```
$ cargo test --test check-versions -- --nocapture
    Finished dev [unoptimized + debuginfo] target(s) in 0.0 secs
     Running target/debug/deps/check_versions-3b40b9d452dd9385

running 1 test
Checking code blocks in README.md...
README.md (line 10) ... ok
test test_readme_deps ... ok

test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out
```

Here the `README.md` file still references version 0.1.0, while the
version number in `Cargo.toml` has been changed to 0.2.0. The test
fails and the code block with the error is shown:

```
$ cargo test --test check-versions -- --nocapture
    Finished dev [unoptimized + debuginfo] target(s) in 0.0 secs
     Running target/debug/deps/check_versions-8fbc5f3b97f4ec3a

running 1 test
Checking code blocks in README.md...
README.md (line 10) ... expected minor version 2, found 1 in
    [dev-dependencies]
    check-versions = "0.1"

thread 'test_readme_deps' panicked at 'dependency errors in README.md', tests/check-versions.rs:6:4
note: Run with `RUST_BACKTRACE=1` for a backtrace.
test test_readme_deps ... FAILED

failures:

failures:
    test_readme_deps

test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out

error: test failed, to rerun pass '--test check-versions'
```

## Release History

This is a changelog describing the most important changes per release.

### Version 0.1.1 — September 18th, 2017

The crate will be renamed to `version-sync` and this is the last
release of the crate under the name `check-versions`.

Version 0.1.1 is identical in functionality to version 0.1.0, except
that using the crate will trigger a deprecation warning with
instructions to use `version-sync` instead.

### Version 0.1.0 — September 10th, 2017

First public release with support for finding outdated version numbers
in `dependencies` and `dev-dependencies`.

## License

The `check-versions` crate can be distributed according to the [MIT
license][mit]. Contributions will be accepted under the same license.

[crates-io]: https://crates.io/crates/check-versions
[api-docs]: https://docs.rs/check-versions/
[travis-ci]: https://travis-ci.org/mgeisler/check-versions
[appveyor]: https://ci.appveyor.com/project/mgeisler/check-versions
[mit]: LICENSE