Skip to content

Commit

Permalink
Prep for 2.8.0 release (#186)
Browse files Browse the repository at this point in the history
* Prep for 2.8.0 release

* no need for lockfile step in release checklist
  • Loading branch information
jsdw committed Jun 21, 2023
1 parent 18d3191 commit 76be3c7
Show file tree
Hide file tree
Showing 4 changed files with 72 additions and 3 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "scale-info"
version = "2.7.0"
version = "2.8.0"
authors = ["Parity Technologies <admin@parity.io>"]
edition = "2021"
rust-version = "1.60.0"
Expand All @@ -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"] }
Expand Down
63 changes: 63 additions & 0 deletions 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.
2 changes: 1 addition & 1 deletion derive/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "scale-info-derive"
version = "2.6.0"
version = "2.8.0"
authors = [
"Parity Technologies <admin@parity.io>",
"Centrality Developers <support@centrality.ai>",
Expand Down

0 comments on commit 76be3c7

Please sign in to comment.