diff --git a/.github/workflows/post-release.yml b/.github/workflows/post-release.yml new file mode 100644 index 0000000..5526a27 --- /dev/null +++ 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 new file mode 100644 index 0000000..e69de29 diff --git a/docs/changelog.rst b/docs/changelog.rst new file mode 100644 index 0000000..f83d445 --- /dev/null +++ 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 index 4b1dd0e..c73500c 100644 --- 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