Skip to content

Commit 048d235

Browse files
authored
chore: add v0.18 changelog (#253)
This commit prepares a new release. It also documents the release process. Thanks iroh team for letting me copy the process.
1 parent da53376 commit 048d235

File tree

2 files changed

+69
-0
lines changed

2 files changed

+69
-0
lines changed

CHANGELOG.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# [v0.18.0](https://github.com/multiformats/rust-multihash/compare/v0.17.0...v) (2022-12-06)
2+
3+
4+
### Bug Fixes
5+
6+
* 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)
7+
* update to Rust edition 2021 ([#255](https://github.com/multiformats/rust-multihash/issues/255)) ([da53376](https://github.com/multiformats/rust-multihash/commit/da53376e0d9cf2d82d6c0d10590a77991cb3a6b6))
8+
9+
10+
### Features
11+
12+
* add `encoded_len` and bytes written ([#252](https://github.com/multiformats/rust-multihash/issues/252)) ([b3cc43e](https://github.com/multiformats/rust-multihash/commit/b3cc43ecb6f9c59da774b094853d6542430d55ad))
13+
14+
15+
### BREAKING CHANGES
16+
17+
* update to Rust edition 2021
18+
* `Multihash::write()` returns bytes written
19+
20+
Prior to this change it returned an empty tuple `()`, now it returns
21+
the bytes written.

RELEASE.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
Release process
2+
===============
3+
4+
Generating Changelog
5+
--------------------
6+
7+
Install dependencies
8+
9+
```sh
10+
$ npm install -g conventional-changelog-cli
11+
$ cd rust-multihash
12+
$ conventional-changelog --preset angular
13+
```
14+
15+
Add the output of that to `CHANGELOG.md`, and write a human-centric summary of changes.
16+
Update the linked output to reference the new version, which conventional-changelog doesn't know about:
17+
18+
```md
19+
# [](https://github.com/multiformats/rust-multihash/compare/v0.17.0...v) (2022-12-06)
20+
```
21+
becomes:
22+
```md
23+
# [v0.18.0](https://github.com/multiformats/rust-multihash/compare/v0.17.0...v0.18.0) (2022-12-06)
24+
```
25+
26+
## Publishing
27+
28+
Publishing on crates.io, bumping version & generating tags is done using [`cargo-release`](https://github.com/crate-ci/cargo-release).
29+
30+
This requires the following permissions
31+
32+
- on github.com/multiformats/rust-multihash
33+
- creating tags
34+
- pushing to `main`
35+
- on crates.io
36+
- publish access to all published crates
37+
38+
Dry run
39+
40+
```sh
41+
$ cargo release <patch|minor|major>
42+
```
43+
44+
Actual publishing
45+
46+
```sh
47+
$ cargo release --execute <patch|minor|major>
48+
```

0 commit comments

Comments
 (0)