CHANGELOG: Follow the "keep a changelog" specification

aldrin/CHANGELOG.md

@@ -1,15 +1,13 @@
-# Unreleased
+# Changelog
 
-## Breaking
-- Rename `ConnectError::VersionMismatch` to `ConnectError::IncompatibleVersion`.
-- `Error` has been redone with now fewer variants and a much smaller size. It now caries contextual
-  information only when that would be inconvenient to get in typical use-cases.
-- All error types except `Error` are now in an `error` module.
-- `Handle::query_service_version()` now returns `Result<u32, Error>` instead of
-  `Result<Option<u32>, Error>`. `Error::InvalidService` is returned in place of `Ok(None)`.
-- Rename `DiscovererBuilder::add_object()` to `object()`.
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## Added
+## [Unreleased]
+
+### Added
 
 - Add `Handle::find_object()` as a convenience function for finding a single object with a specific
   set of services.
@@ -21,24 +19,36 @@
 - Add functions to `Sender` for waiting for the channel to be closed: `is_closed()`, `poll_closed()`
   and `closed()`.
 
+### Changed
+
+- Rename `ConnectError::VersionMismatch` to `ConnectError::IncompatibleVersion`.
+- `Error` has been redone with now fewer variants and a much smaller size. It now caries contextual
+  information only when that would be inconvenient to get in typical use-cases.
+- All error types except `Error` are now in an `error` module.
+- `Handle::query_service_version()` now returns `Result<u32, Error>` instead of
+  `Result<Option<u32>, Error>`. `Error::InvalidService` is returned in place of `Ok(None)`.
+- Rename `DiscovererBuilder::add_object()` to `object()`.
 
-# 0.2.1 (November 28th, 2023)
+## [0.2.1] - 2023-11-28
 
-## Fixed
+### Fixed
 
 - Fix `Discoverer::finished` when no objects have been configured. It now correctly returns `true`
   in this case, just like `next_event` returns `None`.
 
+## [0.2.0] - 2023-11-27
 
-# 0.2.0 (November 27th, 2023)
-
-## Added
+### Added
 
 - Add the functions `Discoverer::start_current_only` and `DiscovererBuilder::build_current_only` to
   have it consider only those object which exist already on the bus at the time of the function
   call.
 
-
-# 0.1.0 (November 24th, 2023)
+## [0.1.0] - 2023-11-24
 
 - Initial release.
+
+[Unreleased]: https://github.com/dennis-hamester/aldrin/compare/aldrin-0.2.1...HEAD
+[0.2.1]: https://github.com/dennis-hamester/aldrin/releases/tag/aldrin-0.2.1
+[0.2.0]: https://github.com/dennis-hamester/aldrin/releases/tag/aldrin-0.2.0
+[0.1.0]: https://github.com/dennis-hamester/aldrin/releases/tag/aldrin-0.1.0

broker/CHANGELOG.md

@@ -1,19 +1,30 @@
-# Unreleased
+# Changelog
 
-## Breaking
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Changed
 
 - The return type of `PendingConnection::client_data()` is changed from `&SerializedValue` to
   `&SerializedValueSlice`.
 - Rename `ConnectionError::UnexpectedBrokerShutdown` to `UnexpectedShutdown`.
 - Rename `EstablishError::VersionMismatch` to `IncompatibleVersion`.
 - Rename `EstablishError::BrokerShutdown` to `Shutdown`.
 
+## [0.2.0] - 2023-11-27
 
-# 0.2.0 (November 27th, 2023)
+### Changed
 
 - Bump for Aldrin 0.2.0.
 
-
-# 0.1.0 (November 24th, 2023)
+## [0.1.0] - 2023-11-24
 
 - Initial release.
+
+[Unreleased]: https://github.com/dennis-hamester/aldrin/compare/aldrin-broker-0.2.1...HEAD
+[0.2.0]: https://github.com/dennis-hamester/aldrin/releases/tag/aldrin-broker-0.2.0
+[0.1.0]: https://github.com/dennis-hamester/aldrin/releases/tag/aldrin-broker-0.1.0

codegen/CHANGELOG.md

@@ -1,27 +1,38 @@
-# Unreleased
+# Changelog
 
-## Breaking
+All notable changes to this project will be documented in this file.
 
-- `aldrin::Error` is now used for every fallible function that is generated. Previously, more
-  specific error types were used in a few places.
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## Added
+## [Unreleased]
+
+### Added
 
 - Support `lifetime` built-in type. It resolves to `aldrin::LifetimeId` in all cases.
 
+### Breaking
+
+- `aldrin::Error` is now used for every fallible function that is generated. Previously, more
+  specific error types were used in a few places.
 
-# 0.2.1 (December 20th, 2023)
+## [0.2.1] - 2023-12-20
 
-## Fixed
+### Fixed
 
 - Fix skipping over unknown fields when deserializing a struct.
 
+## [0.2.0] - 2023-11-27
 
-# 0.2.0 (November 27th, 2023)
+### Changed
 
 - Bump for Aldrin 0.2.0.
 
-
-# 0.1.0 (November 24th, 2023)
+## [0.1.0] - 2023-11-24
 
 - Initial release.
+
+[Unreleased]: https://github.com/dennis-hamester/aldrin/compare/aldrin-codegen-0.2.1...HEAD
+[0.2.1]: https://github.com/dennis-hamester/aldrin/releases/tag/aldrin-codegen-0.2.1
+[0.2.0]: https://github.com/dennis-hamester/aldrin/releases/tag/aldrin-codegen-0.2.0
+[0.1.0]: https://github.com/dennis-hamester/aldrin/releases/tag/aldrin-codegen-0.1.0

core/CHANGELOG.md

@@ -1,10 +1,19 @@
-# 0.2.0 (November 27th, 2023)
+# Changelog
 
-## Added
+All notable changes to this project will be documented in this file.
 
-- Implement `FromStr` for `ObjectUuid` and `ServiceUuid`.
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.2.0] - 2023-11-27
 
+### Added
 
-# 0.1.0 (November 24th, 2023)
+- Implement `FromStr` for `ObjectUuid` and `ServiceUuid`.
+
+## [0.1.0] - 2023-11-24
 
 - Initial release.
+
+[0.2.0]: https://github.com/dennis-hamester/aldrin/releases/tag/aldrin-core-0.2.0
+[0.1.0]: https://github.com/dennis-hamester/aldrin/releases/tag/aldrin-core-0.1.0

gen/CHANGELOG.md

@@ -1,8 +1,19 @@
-# 0.2.0 (November 27th, 2023)
+# Changelog
 
-- Bump for Aldrin 0.2.0.
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.2.0] - 2023-11-27
 
+### Changed
 
-# 0.1.0 (November 24th, 2023)
+- Bump for Aldrin 0.2.0.
+
+## [0.1.0] - 2023-11-24
 
 - Initial release.
+
+[0.2.0]: https://github.com/dennis-hamester/aldrin/releases/tag/aldrin-gen-0.2.0
+[0.1.0]: https://github.com/dennis-hamester/aldrin/releases/tag/aldrin-gen-0.1.0

macros/CHANGELOG.md

@@ -1,8 +1,19 @@
-# 0.2.0 (November 27th, 2023)
+# Changelog
 
-- Bump for Aldrin 0.2.0.
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.2.0] - 2023-11-27
 
+### Changed
 
-# 0.1.0 (November 24th, 2023)
+- Bump for Aldrin 0.2.0.
+
+## [0.1.0] - 2023-11-24
 
 - Initial release.
+
+[0.2.0]: https://github.com/dennis-hamester/aldrin/releases/tag/aldrin-macros-0.2.0
+[0.1.0]: https://github.com/dennis-hamester/aldrin/releases/tag/aldrin-macros-0.1.0

parser/CHANGELOG.md

@@ -1,15 +1,26 @@
-# Unreleased
+# Changelog
 
-## Added
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
 
 - Add built-in type `lifetime`.
 
+## [0.2.0] - 2023-11-27
 
-# 0.2.0 (November 27th, 2023)
+### Changed
 
 - Bump for Aldrin 0.2.0.
 
-
-# 0.1.0 (November 24th, 2023)
+## [0.1.0] - 2023-11-24
 
 - Initial release.
+
+[Unreleased]: https://github.com/dennis-hamester/aldrin/compare/aldrin-parser-0.2.1...HEAD
+[0.2.0]: https://github.com/dennis-hamester/aldrin/releases/tag/aldrin-parser-0.2.0
+[0.1.0]: https://github.com/dennis-hamester/aldrin/releases/tag/aldrin-parser-0.1.0

test/CHANGELOG.md

@@ -1,8 +1,19 @@
-# 0.2.0 (November 27th, 2023)
+# Changelog
 
-- Bump for Aldrin 0.2.0.
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.2.0] - 2023-11-27
 
+### Changed
 
-# 0.1.0 (November 24th, 2023)
+- Bump for Aldrin 0.2.0.
+
+## [0.1.0] - 2023-11-24
 
 - Initial release.
+
+[0.2.0]: https://github.com/dennis-hamester/aldrin/releases/tag/aldrin-test-0.2.0
+[0.1.0]: https://github.com/dennis-hamester/aldrin/releases/tag/aldrin-test-0.1.0