diff --git a/CHANGELOG.md b/CHANGELOG.md index c65e2586..5c1261f0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [2.8.0] - 2023-06-21 + +### Added +- Implement TypeInfo for `Rc` [(#185)](https://github.com/paritytech/scale-info/pull/185) +- Implement TypeInfo for `Duration` [(#184)](https://github.com/paritytech/scale-info/pull/184) + ## [2.7.0] - 2023-05-15 ### Added diff --git a/Cargo.toml b/Cargo.toml index e80c8089..f210664b 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "scale-info" -version = "2.7.0" +version = "2.8.0" authors = ["Parity Technologies "] edition = "2021" rust-version = "1.60.0" @@ -17,7 +17,7 @@ include = ["Cargo.toml", "src/**/*.rs", "README.md", "LICENSE"] [dependencies] bitvec = { version = "1", default-features = false, features = ["alloc"], optional = true } cfg-if = "1.0" -scale-info-derive = { version = "2.6.0", path = "derive", default-features = false, optional = true } +scale-info-derive = { version = "2.8.0", path = "derive", default-features = false, optional = true } serde = { version = "1", default-features = false, optional = true, features = ["derive", "alloc"] } derive_more = { version = "0.99.1", default-features = false, features = ["from"] } scale = { package = "parity-scale-codec", version = "3", default-features = false, features = ["derive"] } diff --git a/RELEASING.md b/RELEASING.md new file mode 100644 index 00000000..2a840955 --- /dev/null +++ b/RELEASING.md @@ -0,0 +1,63 @@ +# Release Checklist + +These steps assume that you've checked out the `scale-info` repository and are in the root directory of it. + +We also assume that ongoing work done is being merged directly to the `master` branch. + +1. Ensure that everything you'd like to see released is on the `master` branch. + +2. Create a release branch off `master`, for example `release-v0.17.0`. Decide how far the version needs to be bumped based + on the changes to date. + +3. Check that you're happy with the current documentation. + + ``` + cargo doc --open + ``` + + If there are minor issues with the documentation, they can be fixed in the release branch. + +4. Bump the crate versions in `./Cargo.toml` and `./derive/Cargo.toml` to whatever was decided in step 2 (basically a find and + replace from old version to new version in this file should do the trick). + +5. Update `CHANGELOG.md` to reflect the difference between this release and the last. See the `CHANGELOG.md` file for + details of the format it follows. + + First, if there have been any significant changes, add a description of those changes to the top of the + changelog entry for this release. + +6. Commit any of the above changes to the release branch and open a PR in GitHub with a base of `master`. + +7. Once the branch has been reviewed and passes CI, merge it. + +8. Now, we're ready to publish the release to crates.io. + + 1. Checkout `master`, ensuring we're looking at that latest merge (`git pull`). + + ``` + git checkout master && git pull + ``` + + 2. Perform a final sanity check that everything looks ok. + + ``` + cargo test --all-targets + ``` + + 3. Run the following command to publish both crates. + + ``` + (cd derive && cargo publish) && cargo publish + ``` + +9. If the release was successful, tag the commit that we released in the `master` branch with the + version that we just released, for example: + + ``` + git tag -s v2.7.0 # use the version number you've just published to crates.io, not this one + git push --tags + ``` + + Once this is pushed, go along to [the releases page on GitHub](https://github.com/paritytech/scale-info/releases) + and draft a new release which points to the tag you just pushed to `master` above. Copy the changelog comments + for the current release into the release description. diff --git a/derive/Cargo.toml b/derive/Cargo.toml index 4bd1174c..9d120fa3 100644 --- a/derive/Cargo.toml +++ b/derive/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "scale-info-derive" -version = "2.6.0" +version = "2.8.0" authors = [ "Parity Technologies ", "Centrality Developers ",