-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Release v14.3.0 * Add a release checklist * Edition 2021 * Update CHANGELOG * Update CHANGELOG.md Co-authored-by: Andronik <write@reusable.software> * It's a breaking change: 15.0.0 Co-authored-by: Andronik <write@reusable.software>
- Loading branch information
Showing
4 changed files
with
78 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,29 +1,45 @@ | ||
|
||
# Changelog | ||
|
||
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). | ||
|
||
## [Unreleased] | ||
|
||
## [15.0.0] - 2022-02-08 | ||
|
||
### Changed | ||
|
||
- Update edition to 2021 | ||
- Update `scale-info` to v2.0.0 and `parity-scale-codec` to v3.0.0 [#35](https://github.com/paritytech/frame-metadata/pull/35) | ||
|
||
## [14.2.0] - 2021-11-04 | ||
|
||
- Add function to return metadata version [#30](https://github.com/paritytech/frame-metadata/pull/30) | ||
|
||
## [14.1.0] - 2021-11-03 | ||
|
||
- Add metadata version v8-v11 [#28](https://github.com/paritytech/frame-metadata/pull/28) | ||
- Combine Map/NMap/DoubleMap StorageEntryTypes [#23](https://github.com/paritytech/frame-metadata/pull/23) | ||
|
||
## [14.0.0] - 2021-09-01 | ||
|
||
## [14.0.0-rc.3] - 2021-08-31 | ||
|
||
### Added | ||
|
||
- Add Runtime type to metadata | ||
|
||
## [14.0.0-rc.2] - 2021-08-04 | ||
|
||
### Changed | ||
|
||
Combine Map/NMap/DoubleMap StorageEntryTypes [#23](https://github.com/paritytech/frame-metadata/pull/23) | ||
|
||
## [14.0.0-rc.1] - 2021-07-30 | ||
|
||
### Added | ||
|
||
- Metadata V14 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
# Release Checklist | ||
|
||
These steps assume that you've checked out the `frame-metadata` repository and are in the root directory of it. | ||
|
||
We also assume that ongoing work done is being merged directly to the `main` branch. | ||
|
||
1. Ensure that everything you'd like to see released is on the `main` branch. | ||
|
||
2. Create a release branch off `main`, for example `release-v14.3.0`. Decide how far the version needs to be bumped based | ||
on the changes to date. If unsure what to bump the version to (e.g. is it a major, minor or patch release), check with the | ||
Parity Tools team. | ||
|
||
3. Check that you're happy with the current documentation. | ||
|
||
```bash | ||
cargo doc --open --all-features | ||
``` | ||
|
||
Optionally you can also confirm that any external links | ||
are still valid like so: | ||
|
||
```bash | ||
cargo install cargo-deadlinks | ||
cargo deadlinks --check-http -- --all-features | ||
``` | ||
|
||
If there are minor issues with the documentation, they can be fixed in the release branch. | ||
|
||
4. Bump the crate version in `frame-metadata/Cargo.toml` to whatever was decided in step 2. | ||
|
||
5. Update `CHANGELOG.md` to reflect the difference between this release and the last. If you're unsure of | ||
what to add, check with the Tools team. See the `CHANGELOG.md` file for details of the format it follows. | ||
Any [closed PRs](https://github.com/paritytech/frame-metadata/pulls?q=is%3Apr+sort%3Aupdated-desc+is%3Aclosed) between the last release and | ||
this release branch should be noted. | ||
6. Commit any of the above changes to the release branch and open a PR in GitHub with a base of `main`. | ||
7. Once the branch has been reviewed and passes CI, merge it. | ||
8. Now, we're ready to publish the release to crates.io. | ||
|
||
Checkout `main`, ensuring we're looking at that latest merge (`git pull`). | ||
```bash | ||
cd frame-metadata && cargo publish | ||
``` | ||
9. If the release was successful, tag the commit that we released in the `main` branch with the | ||
version that we just released, for example: | ||
```bash | ||
git tag -s v14.3.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/frame-metadata/releases) | ||
and draft a new release which points to the tag you just pushed to `main` above. Copy the changelog comments | ||
for the current release into the release description. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters