diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml new file mode 100644 index 0000000..5ad6fcd --- /dev/null +++ b/.github/release-drafter.yml @@ -0,0 +1,22 @@ +categories: + - title: '🚀 Features' + labels: + - 'feature' + - 'enhancement' + - 'core feature' + - title: '🐛 Bug Fixes' + labels: + - 'fix' + - 'bugfix' + - 'bug' + - title: '🧰 Maintenance' + labels: + - 'refactoring' + - 'maintenance' + - title: '📖 Documentation' + labels: + - 'documentation' +template: | + ## What's Changed + + $CHANGES \ No newline at end of file diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml new file mode 100644 index 0000000..888e344 --- /dev/null +++ b/.github/workflows/release-drafter.yml @@ -0,0 +1,35 @@ +name: Release Drafter + +on: + # workflow_dispatch allows manual runs so the release notes can be rebuilt after PRs are renamed or relabeled + workflow_dispatch: + push: + # branches to consider in the event; optional, defaults to all + branches: + - main + # pull_request event is required only for autolabeler + pull_request: + # Only following types are handled by the action, but one can default to all as well + types: [opened, reopened, synchronize] + +permissions: + contents: read + +jobs: + update_release_draft: + permissions: + # write permission is required to create a github release + contents: write + # write permission is required for autolabeler + # otherwise, read permission is required at least + pull-requests: read + runs-on: ubuntu-latest + steps: + # Drafts your next Release notes as Pull Requests are merged into main + - uses: release-drafter/release-drafter@v6 + # (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml + # with: + # config-name: my-config.yml + # disable-autolabeler: true + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file