diff options
| -rw-r--r-- | .github/workflows/changelog.yml | 47 | ||||
| -rw-r--r-- | docs/source/changelog.rst | 1 | ||||
| -rw-r--r-- | docs/source/index.rst | 9 |
3 files changed, 56 insertions, 1 deletions
diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml new file mode 100644 index 0000000..d6917bd --- /dev/null +++ b/.github/workflows/changelog.yml @@ -0,0 +1,47 @@ +name: CHANGELOG + +on: + push: + # tags: + # - "v*" + # - v[0-9]+.[0-9]+.[0-9]+ + workflow_dispatch: + +jobs: + deploy: + runs-on: ubuntu-latest + permissions: + contents: write + pull-requests: write + id-token: write + steps: + - name: Checkout Code + uses: actions/checkout@v4 + + - name: Update CHANGELOG + id: changelog + uses: requarks/changelog-action@v1 + with: + token: ${{ github.token }} + tag: ${{ github.ref_name }} + includeInvalidCommits: true + changelogFilePath: CHANGELOG.md + writeToFile: true + useGitmojis: false + + - name: Create Release + uses: ncipollo/release-action@v1.14.0 + with: + allowUpdates: true + draft: false + makeLatest: true + name: ${{ github.ref_name }} + body: ${{ steps.changelog.outputs.changes }} + token: ${{ github.token }} + + - name: Commit CHANGELOG.md + uses: stefanzweifel/git-auto-commit-action@v5 + with: + branch: main + commit_message: 'docs: update CHANGELOG.md for ${{ github.ref_name }} [skip ci]' + file_pattern: CHANGELOG.md
\ No newline at end of file diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst new file mode 100644 index 0000000..3c58b59 --- /dev/null +++ b/docs/source/changelog.rst @@ -0,0 +1 @@ +.. include::../../CHANGELOG.md
\ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index ea482de..df177f3 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -15,4 +15,11 @@ This is a template for documentation projects. :hidden: :caption: Contents - contents/index
\ No newline at end of file + contents/index + +.. toctree:: + :hidden: + :caption: Helpings + + changelog + |