Add initial changelog

.github/workflows/CI.yml

@@ -72,6 +72,27 @@ 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:
+      - uses: actions/checkout@v3
+      - name: Get version from tag
+        id: changelog_version
+        run: |
+          if [[ "$GITHUB_REF" == "refs/tags/*" ]]; then
+            echo "version=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
+          else
+            echo "version=Unreleased" >> $GITHUB_OUTPUT
+          fi
+      - name: Get changelog entry
+        id: changelog
+        uses: mindsers/changelog-reader-action@v2
+        with:
+          validation_level: error
+          # version: ${{ github.ref }}
+          version: ${{ steps.changelog_version.outputs.version }}
+          path: ./CHANGELOG.md
 
   deploy:
     name: Deploy package
@@ -92,7 +113,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:

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