Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ensure version number consistency #51

Merged

Conversation

mgeisler
Copy link
Contributor

This adds a test that will check the examples in README.md for the
current package version.

It also checks that there is a Markdown heading mentioning (at least)
the current version. This serves as a simple check that the change log
section is updated when the version number is bumped.

Related to #30, #41, #47, and #48.

This seems to have been forgotten in 703e9c2.
This adds a test that will check the examples in README.md for the
current package version.

It also checks that there is a Markdown heading mentioning (at least)
the current version. This serves as a simple check that the change log
section is updated when the version number is bumped.

Related to unicode-rs#30, unicode-rs#41, unicode-rs#47, and unicode-rs#48.
@mgeisler
Copy link
Contributor Author

The version-sync crate is a Rust 2018 crate — please let me know if you need the tests to pass in earlier versions. This is in turn related to my old PR here, which asks for a documented minimum supported Rust version in the Travis config: #27.

@Manishearth Manishearth merged commit 2659888 into unicode-rs:master Mar 31, 2019
Manishearth added a commit that referenced this pull request Mar 31, 2019
…nsistency"

This reverts commit 2659888, reversing
changes made to 41a0424.
@Manishearth
Copy link
Member

Yeah, this breaks travis from the other PR. Reverted.

Also I'm not really sure if this test is necessary. Overall for minor bumps Cargo automatically updates to the latest version, and we don't do semiminor/major bumps all too often. Seems a bit heavyweight.

@mgeisler
Copy link
Contributor Author

Right, version-sync 0.8.0 doesn't work with Rust 1.24.0, but version 0.6.0 does. In any case, I hope it's still useful to keep the changelog updated, so I've put up #52 with that change alone. Hope you like it.

It's for sure a little heavy-weight and rigid to parse the README like this, but the string of issues mentioned above seems to indicate that it's necessary to ensure the documentation is up to date.

@Manishearth
Copy link
Member

Sure, but it's also not that major an issue when it happens. This crate doesn't change much, aside from unicode releases.

@mgeisler
Copy link
Contributor Author

mgeisler commented Apr 1, 2019

Yeah, it's just a minor thing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants