Skip to content

Commit

Permalink
chore: add v0.18 changelog (#253)
Browse files Browse the repository at this point in the history
This commit prepares a new release. It also documents the release
process. Thanks iroh team for letting me copy the process.
  • Loading branch information
vmx authored Dec 6, 2022
1 parent da53376 commit 048d235
Show file tree
Hide file tree
Showing 2 changed files with 69 additions and 0 deletions.
21 changes: 21 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# [v0.18.0](https://github.com/multiformats/rust-multihash/compare/v0.17.0...v) (2022-12-06)


### Bug Fixes

* 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))


### 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

* 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.
48 changes: 48 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
Release process
===============

Generating Changelog
--------------------

Install dependencies

```sh
$ npm install -g conventional-changelog-cli
$ cd rust-multihash
$ conventional-changelog --preset angular
```

Add the output of that to `CHANGELOG.md`, and write a human-centric summary of changes.
Update the linked output to reference the new version, which conventional-changelog doesn't know about:

```md
# [](https://github.com/multiformats/rust-multihash/compare/v0.17.0...v) (2022-12-06)
```
becomes:
```md
# [v0.18.0](https://github.com/multiformats/rust-multihash/compare/v0.17.0...v0.18.0) (2022-12-06)
```

## Publishing

Publishing on crates.io, bumping version & generating tags is done using [`cargo-release`](https://github.com/crate-ci/cargo-release).

This requires the following permissions

- on github.com/multiformats/rust-multihash
- creating tags
- pushing to `main`
- on crates.io
- publish access to all published crates

Dry run

```sh
$ cargo release <patch|minor|major>
```

Actual publishing

```sh
$ cargo release --execute <patch|minor|major>
```

0 comments on commit 048d235

Please sign in to comment.