From 20c863e6604444d4d52d0dd91258a5b3cea5cb42 Mon Sep 17 00:00:00 2001 From: Xevion Date: Tue, 8 Oct 2024 15:31:04 -0500 Subject: [PATCH] Use keep-a-changelog style for CHANGELOG.md --- CHANGELOG.md | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 45a1a22..5dba44b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,17 +2,31 @@ All notable changes to this project will be documented in this file. -## [Unreleased v0.2.0] +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] + +### Changed - Adjusted `github-linguist` statistics, ignoring `.hooks` - Widened `paths-ignore` for `build` and `test` workflows. -- Removed `paths-ignore` for `build` workflow on `push` trigger. - Switched release step token to use `secrets.GH_RELEASE_TOKEN`, so the author is bound to `Xevion` instead of `github-actions` (a bot). +- Switched changelog format to `keep-a-changelog` style. + +### Removed + +- Removed `paths-ignore` for `build` workflow on `push` trigger. ## v0.1.6 +### Added + - Began tracking changes in the `CHANGELOG.md` file. -- [breaking] Lowered MSRV to 1.74 to match `librespot`'s `0.5.0-dev` branch. -- Fixed `pre-commit` hook to properly process the `CARGO_README.md` file. - Added testing workflow to the repository, targeting only major x64 platforms. -- New testing badge in README \ No newline at end of file +- Added testing badge to README + +### Changed + +- [breaking] Lowered MSRV to 1.74 to match `librespot`'s `0.5.0-dev` branch. +- Fixed `pre-commit` hook to properly process the `CARGO_README.md` file. \ No newline at end of file