From ff23ed5b224fb96f744ae787913f864b9fb6f60a Mon Sep 17 00:00:00 2001 From: Volker Mische Date: Wed, 31 May 2023 10:40:19 +0200 Subject: [PATCH] chore: update release instructions Make it clearer that the changelog is the place for explaining migrations. Also change the changelog from angular to the conventionalcommits style as mentioned at https://github.com/multiformats/rust-multihash/pull/276#issuecomment-1479206358. --- CHANGELOG.md | 20 ++++++++++---------- RELEASE.md | 5 +++-- 2 files changed, 13 insertions(+), 12 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4628fe43..0863eb18 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ -# [v0.18.1](https://github.com/multiformats/rust-multihash/compare/v0.18.0...v0.18.1) (2023-04-14) +## [v0.18.1](https://github.com/multiformats/rust-multihash/compare/v0.18.0...v0.18.1) (2023-04-14) ### Bug Fixes @@ -6,24 +6,24 @@ * don't panic on non minimal varints ([#293](https://github.com/multiformats/rust-multihash/issues/293)) ([c3445fc](https://github.com/multiformats/rust-multihash/commit/c3445fc5041b0fc573945321ebd4b0cdffe0daa5)), closes [#282](https://github.com/multiformats/rust-multihash/issues/282) -# [v0.18.0](https://github.com/multiformats/rust-multihash/compare/v0.17.0...v) (2022-12-06) +## [0.18.0](https://github.com/multiformats/rust-multihash/compare/v0.17.0...v0.18.0) (2022-12-06) -### Bug Fixes +### ⚠ BREAKING CHANGES -* remove Nix support ([#254](https://github.com/multiformats/rust-multihash/issues/254)) ([ebf57dd](https://github.com/multiformats/rust-multihash/commit/ebf57ddb82be2d2fd0a2f00666b0f888d4c78e1b)), closes [#247](https://github.com/multiformats/rust-multihash/issues/247) -* update to Rust edition 2021 ([#255](https://github.com/multiformats/rust-multihash/issues/255)) ([da53376](https://github.com/multiformats/rust-multihash/commit/da53376e0d9cf2d82d6c0d10590a77991cb3a6b6)) +* update to Rust edition 2021 +* `Multihash::write()` returns bytes written + Prior to this change it returned an empty tuple `()`, now it returns +the bytes written. ### Features * add `encoded_len` and bytes written ([#252](https://github.com/multiformats/rust-multihash/issues/252)) ([b3cc43e](https://github.com/multiformats/rust-multihash/commit/b3cc43ecb6f9c59da774b094853d6542430d55ad)) -### BREAKING CHANGES +### Bug Fixes -* update to Rust edition 2021 -* `Multihash::write()` returns bytes written +* remove Nix support ([#254](https://github.com/multiformats/rust-multihash/issues/254)) ([ebf57dd](https://github.com/multiformats/rust-multihash/commit/ebf57ddb82be2d2fd0a2f00666b0f888d4c78e1b)), closes [#247](https://github.com/multiformats/rust-multihash/issues/247) +* update to Rust edition 2021 ([#255](https://github.com/multiformats/rust-multihash/issues/255)) ([da53376](https://github.com/multiformats/rust-multihash/commit/da53376e0d9cf2d82d6c0d10590a77991cb3a6b6)) - Prior to this change it returned an empty tuple `()`, now it returns -the bytes written. diff --git a/RELEASE.md b/RELEASE.md index e5284a2b..c0d44ba7 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -9,10 +9,11 @@ Install dependencies ```sh $ npm install -g conventional-changelog-cli $ cd rust-multihash -$ conventional-changelog --preset angular +$ conventional-changelog --preset conventionalcommits ``` -Add the output of that to `CHANGELOG.md`, and write a human-centric summary of changes. +Add the output of that to `CHANGELOG.md`. Write a human-centric summary of changes and add migration instructions for breaking changes if needed. + Update the linked output to reference the new version, which conventional-changelog doesn't know about: ```md