Automatic Changelog (#213)

* automatic changelog * add changelog to docs
pymc-devs · Dec 28, 2024 · 139aeac · 139aeac
1 parent b84ba1c
commit 139aeac
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 5 deletions.
diff --git a/.github/workflows/post-release.yml b/.github/workflows/post-release.yml
@@ -0,0 +1,19 @@
+name: Post-release
+on:
+  release:
+    types: [published, released]
+  workflow_dispatch:
+
+jobs:
+  changelog:
+    name: Update changelog
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: main
+      - uses: rhysd/changelog-from-release/action@v3
+        with:
+          file: CHANGELOG.md
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          commit_summary_template: 'update changelog for %s changes'
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -0,0 +1,5 @@
+Changelog
+*********
+
+.. include:: ../CHANGELOG.md
+   :parser: myst_parser.sphinx_
diff --git a/docs/index.rst b/docs/index.rst
@@ -93,10 +93,12 @@ Contents
    :maxdepth: 2
 
    examples
-   api_reference
 
-Indices
-=======
+References
+==========
+
+.. toctree::
+   :maxdepth: 1
 
-* :ref:`genindex`
-* :ref:`modindex`
+   api_reference
+   changelog