-
Notifications
You must be signed in to change notification settings - Fork 45
Release checklist
Tomas Sedovic edited this page Dec 19, 2018
·
9 revisions
- (optional) Bump the
tcod-sys
version intcod_sys/Cargo.toml
following http://semver.org/ - (optional) Publish
tcod-sys
to crates.io if we have a new version:cd tcod_sys && cargo package && ls -alh target/package/
cargo publish
- Check the tcod-sys crates.io page
- Bump the
tcod
version following http://semver.org/ - Bump the tcod version in the
How to use this
part of theREADME
, too! - Verify everything builds fine:
cargo build
cargo build --release
cargo build --examples
cargo test
git commit -m "Bump tcod to $version"
- Create a pull request for the version bump commit
- Verify the CI passes
- Merge it
- Run
make package
- Check that
target/package/tcod-$version
appears sane (e.g. it's not taking up 20MB) - Create a tag for the new version:
git tag -a -m "Release version v${VERSION}" v$VERSION
(e.g.git tag v3.4.6
) - Push the tag:
git push --follow-tags
- Run
cargo publish
- Add the release notes:
- Go to: https://github.com/tomassedovic/tcod-rs/releases
- Click the
Draft a new release
button - Select the new tag from the
Tag version
dropdown - Write the version (without the
v
prefix, e.g.3.4.6
) as theRelease title
- Look through the new commits in this release and write a summary in the release notes section