Crate version_sync [−] [src]

version-sync provides macros for keeping version numbers in sync with your crate version.

When making a release of a Rust project, you typically need to adjust some version numbers in your code and documentation. This crate gives you macros that covers the two usual cases where version numbers need updating:

TOML examples in the README.md files that show how to add a dependency on your crate. See assert_markdown_deps_updated.
The html_root_url attribute that tells other crates where to find your documentation. See assert_html_root_url_updated.

A typical configuration will use an integration test to verify that all version numbers are in sync. Create a tests/version-numbers.rs file with:

#[macro_use]
extern crate version_sync;

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

#[test]
fn test_html_root_url() {
    assert_html_root_url_updated!("src/lib.rs");
}

When you run cargo test, your version numbers will be automatically checked.

Macros

assert_html_root_url_updated	Assert that the `html_root_url` attribute is up to date.
assert_markdown_deps_updated	Assert that dependencies on the current package are up to date.

Functions

check_html_root_url	Check version numbers in `html_root_url` attributes.
check_markdown_deps	Check dependencies in Markdown code blocks.