Release v15.0.0 (#36)

* 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>
This commit is contained in:
DavidandAndronik authored and GitHub committed 2022-02-08 18:21:15 +00:00
1 parent cdb863d11b
commit d241ab9c1b
4 files changed
+78 -1

No files matched your search

+16
View File
@@ -1,5 +1,6 @@
# Changelog # Changelog
All notable changes to this project will be documented in this file. 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/), The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
@@ -7,23 +8,38 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased] ## [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 ## [14.2.0] - 2021-11-04
- Add function to return metadata version [#30](https://github.com/paritytech/frame-metadata/pull/30) - Add function to return metadata version [#30](https://github.com/paritytech/frame-metadata/pull/30)
## [14.1.0] - 2021-11-03 ## [14.1.0] - 2021-11-03
- Add metadata version v8-v11 [#28](https://github.com/paritytech/frame-metadata/pull/28) - 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) - Combine Map/NMap/DoubleMap StorageEntryTypes [#23](https://github.com/paritytech/frame-metadata/pull/23)
## [14.0.0] - 2021-09-01 ## [14.0.0] - 2021-09-01
## [14.0.0-rc.3] - 2021-08-31 ## [14.0.0-rc.3] - 2021-08-31
### Added ### Added
- Add Runtime type to metadata - Add Runtime type to metadata
## [14.0.0-rc.2] - 2021-08-04 ## [14.0.0-rc.2] - 2021-08-04
### Changed ### Changed
Combine Map/NMap/DoubleMap StorageEntryTypes [#23](https://github.com/paritytech/frame-metadata/pull/23) Combine Map/NMap/DoubleMap StorageEntryTypes [#23](https://github.com/paritytech/frame-metadata/pull/23)
## [14.0.0-rc.1] - 2021-07-30 ## [14.0.0-rc.1] - 2021-07-30
### Added ### Added
- Metadata V14 - Metadata V14
+2
View File
@@ -5,7 +5,9 @@ Defines FRAME metadata types for [Substrate](https://github.com/paritytech/subst
Originally part of the `substrate` repository, it was extracted here as part of https://github.com/paritytech/substrate/pull/8615. Originally part of the `substrate` repository, it was extracted here as part of https://github.com/paritytech/substrate/pull/8615.
## Versioning ## Versioning
Starting from `v8`, all historical metadata type definitions are retained. These can be enabled via features e.g. `v13`. The latest version is enabled by default. All legacy versions are available under the `legacy` feature. Starting from `v8`, all historical metadata type definitions are retained. These can be enabled via features e.g. `v13`. The latest version is enabled by default. All legacy versions are available under the `legacy` feature.
### Tooling ### Tooling
The intention is to provide tooling here in the future to handle the different versions of metadata. The intention is to provide tooling here in the future to handle the different versions of metadata.
+59
View File
@@ -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.
+1 -1
View File
@@ -2,7 +2,7 @@
name = "frame-metadata" name = "frame-metadata"
version = "15.0.0" version = "15.0.0"
authors = ["Parity Technologies <admin@parity.io>"] authors = ["Parity Technologies <admin@parity.io>"]
edition = "2018" edition = "2021"
license = "Apache-2.0" license = "Apache-2.0"
homepage = "https://substrate.dev" homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/frame-metadata/" repository = "https://github.com/paritytech/frame-metadata/"