Skip to content

Commit c1a7141

Browse files
committed
add CHANGELOG
now that the crate has been released new (notable) changes should be documented for consumers. the updating of the changelog for releases is automated using [`cargo release`)[https://github.com/crate-ci/cargo-release).
1 parent c361ecd commit c1a7141

File tree

3 files changed

+23
-0
lines changed

3 files changed

+23
-0
lines changed

CHANGELOG.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+
4+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
7+
<!-- next-header -->
8+
## [Unreleased] - ReleaseDate
9+
### Changed
10+
* The Minimum Supported Rust Version (MSRV) has been defined as 1.60.0 and is being enforced in `Cargo.toml`
11+
12+
<!-- next-url -->
13+
[Unreleased]: https://github.com/rursprung/adafruit-bluefruit-protocol-rs/compare/v0.1.0...HEAD

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ Note that this work is not affiliated with Adafruit.
1717
but you can opt to only select the event(s) you are interested in which will result in a small binary size.
1818
If other events are received, a `ProtocolParseError::DisabledControllerDataPackageType` will be returned.
1919

20+
## Changelog
21+
For the changelog please see the dedicated [CHANGELOG.md](CHANGELOG.md).
22+
2023
## Minimum Supported Rust Version (MSRV)
2124
This crate is guaranteed to compile on stable Rust 1.60 and up. It *might*
2225
compile with older versions but that may change in any new patch release.

release.toml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
pre-release-replacements = [
2+
{file="CHANGELOG.md", search="Unreleased", replace="{{version}}", min=1},
3+
{file="CHANGELOG.md", search="\\.\\.\\.HEAD", replace="...{{tag_name}}", exactly=1},
4+
{file="CHANGELOG.md", search="ReleaseDate", replace="{{date}}", min=1},
5+
{file="CHANGELOG.md", search="<!-- next-header -->", replace="<!-- next-header -->\n## [Unreleased] - ReleaseDate\n", exactly=1},
6+
{file="CHANGELOG.md", search="<!-- next-url -->", replace="<!-- next-url -->\n[Unreleased]: https://github.com/rursprung/adafruit-bluefruit-protocol-rs/compare/{{tag_name}}...HEAD", exactly=1},
7+
]

0 commit comments

Comments
 (0)