docs(changelog): move log to documentation

.github/workflows/release_package.yml

@@ -17,22 +17,10 @@ jobs:
 
     steps:
       - name: Checkout Repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
-      - name: Generate a changelog
-        uses: orhun/git-cliff-action@v2
-        id: git-cliff
-        with:
-          config: cliff.toml
-          args: --verbose
-        env:
-          OUTPUT: CHANGELOG.md
-
-      - name: Add Changelog
-        run: |
-          git add CHANGELOG.md
 
       # This action uses Python Semantic Release v8
       - name: Python Semantic Release
@@ -55,3 +43,23 @@ jobs:
         if: steps.release.outputs.released == 'true'
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
+
+      # Update Changelog; this must be done after the release
+      - name: Generate a changelog
+        uses: orhun/git-cliff-action@v3
+        id: git-cliff
+        with:
+          config: cliff.toml
+          args: --verbose
+        env:
+          OUTPUT: docs/whats_new/CHANGELOG.md
+          GITHUB_REPO: ${{ github.repository }}
+
+      - name: Commit Changelog
+        run: |
+          git config user.name 'github-actions[bot]'
+          git config user.email 'github-actions[bot]@users.noreply.github.com'
+          set +e
+          git add docs/whats_new/CHANGELOG.md
+          git commit -m "docs(changelog): update changelog"
+          git push https://${{ secrets.GITHUB_TOKEN }}@github.com/${GITHUB_REPOSITORY}.git main

cliff.toml

@@ -4,7 +4,7 @@
 [changelog]
 # changelog header
 header = """
-# Changelog\n
+# What's New?\n
 All notable changes to this project will be documented in this file. See [conventional commits](https://www.conventionalcommits.org/) for commit guidelines.\n
 """
 # template for the changelog body
@@ -62,18 +62,18 @@ commit_preprocessors = [
 ]
 # regex for parsing and grouping commits
 commit_parsers = [
-    { message = "^feat", group = "<!-- 00 -->:rocket: Features" },
-    { message = "^perf", group = "<!-- 01 -->:zap: Performance" },
-    { message = "^fix", group = "<!-- 02 -->:bug: Bug Fixes" },
-    { message = "^doc", group = "<!-- 04 -->:book: Documentation" },
-    { message = "^refactor", group = "<!-- 05 -->:hammer_and_wrench: Refactoring" },
-    { message = "^style", group = "<!-- 06 -->:art: Style" },
-    { message = "^revert", group = "<!-- 07 -->:rewind: Revert" },
-    { message = "^test", group = "<!-- 08 -->:microscope: Tests" },
+    { message = "^feat", group = "<!-- 00 -->⭐ Features" },
+    { message = "^perf", group = "<!-- 01 -->🚀 Performance" },
+    { message = "^fix", group = "<!-- 02 -->🐛 Bug Fixes" },
+    { message = "^doc", group = "<!-- 04 -->🔖 Documentation" },
+    { message = "^refactor", group = "<!-- 05 -->🛠️ Refactoring" },
+    { message = "^style", group = "<!-- 06 -->🎨 Style" },
+    { message = "^revert", group = "<!-- 07 -->♻️ Revert" },
+    { message = "^test", group = "<!-- 08 -->✅ Tests" },
     { message = "^chore: release", skip = true },
     { message = "^chore\\(release\\):", skip = true },
-    { message = "^chore|ci|build", group = "<!-- 09 -->:gear: Miscellaneous" },
-    { body = ".*security", group = "<!-- 10 -->:shield: Security" },
+    { message = "^chore|ci|build", group = "<!-- 09 -->⚙️ Miscellaneous" },
+    { body = ".*security", group = "<!-- 10 -->🔒 Security" },
 ]
 # protect breaking changes from being skipped due to matching a skipping commit_parser
 protect_breaking_commits = false

docs/conf.py

@@ -56,6 +56,7 @@
     "sphinx_design",
     "nbsphinx",
     "sphinx_copybutton",
+    "myst_parser",  # markdown support
 ]
 autosummary_generate = True  # Turn on sphinx.ext.autosummary
 

docs/index.rst

@@ -27,6 +27,7 @@ Extracting Patterns from Climate Data
   user_guide/index
   installation
   api_reference/index
+  whats_new/CHANGELOG
   contributing_guide