diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index 71f4fe2..0639297 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -72,6 +72,17 @@ jobs: # root path path: docs # node-version: 18 # The specific version of Node that should be used to build your site. Defaults to 18. (optional) + changelog: + name: Build docs + runs-on: ubuntu-latest + steps: + - name: Get changelog entry + id: changelog + uses: mindsers/changelog-reader-action@v2 + with: + validation_level: error + version: ${{ github.ref }} + path: ./CHANGELOG.md deploy: name: Deploy package @@ -92,7 +103,7 @@ jobs: tag: ${{ github.ref }} overwrite: true file_glob: true - # body: "This is my release text" + # body: ${{ steps.changelog.outputs.changes }} - name: Publish to PyPI uses: PyO3/maturin-action@v1 env: diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..2cd4f26 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,38 @@ +# Changelog + +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.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Added + +- Improved e2e tests +- Stabilized text mapper +- Stabilized chord mapper +- Documentation for text and chord mappers +- New changelog +- Github actions CI for release notes + +### Fixed + +- Text mapper bugs +- Documentation cleanup + +## [2.1.17] - 2024-05-32 + +### Added + +- Improved e2e tests +- Stabilized text mapper +- Stabilized chord mapper +- Documentation for text and chord mappers +- New changelog +- Github actions CI for release notes + +### Fixed + +- Text mapper bugs +- Documentation cleanup