diff --git a/CHANGELOG.md b/CHANGELOG.md index a723de2..051f7bd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,11 +2,28 @@ All notable changes to this Rust implementation of hypercore-protocol will be documented here. -### 7.0.1 +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + + + +## [Unreleased] - ReleaseDate + +### Added + +### Changed + +* Fix `Open`/`Close` messages corrupting multi-message batches. + +### Removed + + + +## [0.7.1] - 2026-06-04 * Rewrite serveral async methods to return owned futures and fix a busy loop ([PR 148](https://github.com/datrs/hypercore-protocol-rs/pull/24)). -### 7.0.0 +## [0.7.0] - 2026-02-19 BIG CHANGES: * Encryption and framing of streams has been moved out of this crate into `hypercore_handshake` and `uint24le_framing` respectively. This had big impacts on the public API. Now `Protocol::new` just takes a `impl CipherTrait` argument. @@ -14,33 +31,33 @@ BIG CHANGES: * Bumped to edition 2024. * Dropped support for async-std (and its feature flag) -### 0.6.1 +## [0.6.1] - 2024-10-28 * Implement Clone on Channel, remove unnecessary mut requirements, and improve Protocol debugging. -### 0.6.0 +## [0.6.0] - 2024-10-25 #### API breaking changes Support hypercore v0.14.0 and change tokio as the default async runtime. -### 0.5.0 +## [0.5.0] - 2024-07-05 #### API breaking changes Support hypercore v0.13.0 which [removed generic parameters from Hypercore and Storage][https://github.com/datrs/hypercore/pull/139]. -### 0.4.1 +## [0.4.1] - 2023-10-26 * Implement close() and signal_local() in CommandTx -### 0.4.0 +## [0.4.0] - 2023-10-12 #### API breaking changes * Support for [Hypercore LTS v10](https://github.com/holepunchto/hypercore) which is backward incompatible with v9 and thus v0.3.0 of this crate. This resulted in many changes throughout the API. -### 0.3.0 +## 0.3.0 #### API breaking changes @@ -51,6 +68,16 @@ Support hypercore v0.13.0 which [removed generic parameters from Hypercore and S * Changed key and discovery key values to be `[u8; 32]` in place of `Vec` > . To convert from a `Vec`, use `key.try_into().unwrap()` if you're sure that the key is a 32 byte long `u8` vector. -### 0.0.2 +## 0.0.2 initial release + + +[Unreleased]: https://github.com/datrs/hypercore-protocol-rs/compare/v0.7.1...HEAD +[0.7.1]: https://github.com/datrs/hypercore-protocol-rs/compare/v0.7.0...v0.7.1 +[0.7.0]: https://github.com/datrs/hypercore-protocol-rs/compare/v0.6.1...v0.7.0 +[0.6.1]: https://github.com/datrs/hypercore-protocol-rs/compare/v0.6.0...v0.6.1 +[0.6.0]: https://github.com/datrs/hypercore-protocol-rs/compare/v0.5.0...v0.6.0 +[0.5.0]: https://github.com/datrs/hypercore-protocol-rs/compare/v0.4.1...v0.5.0 +[0.4.1]: https://github.com/datrs/hypercore-protocol-rs/compare/v0.4.0...v0.4.1 +[0.4.0]: https://github.com/datrs/hypercore-protocol-rs/releases/tag/v0.4.0 diff --git a/release.toml b/release.toml new file mode 100644 index 0000000..7cd8860 --- /dev/null +++ b/release.toml @@ -0,0 +1,7 @@ +pre-release-replacements = [ + {file="CHANGELOG.md", search="Unreleased", replace="{{version}}"}, + {file="CHANGELOG.md", search="\\.\\.\\.HEAD", replace="...{{tag_name}}", exactly=1}, + {file="CHANGELOG.md", search="ReleaseDate", replace="{{date}}"}, + {file="CHANGELOG.md", search="", replace="\n\n## [Unreleased] - ReleaseDate\n\n### Added\n\n### Changed\n\n### Removed\n\n", exactly=1}, + {file="CHANGELOG.md", search="", replace="\n[Unreleased]: https://github.com/datrs/hypercore-protocol-rs/compare/{{tag_name}}...HEAD", exactly=1}, +]