diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml new file mode 100644 index 0000000..df171e7 --- /dev/null +++ b/.github/release-drafter.yml @@ -0,0 +1,95 @@ +name-template: 'v$RESOLVED_VERSION' +tag-template: 'v$RESOLVED_VERSION' + + +categories: + - title: '💥 Breaking changes' + labels: + - ':boom: breaking change' + - title: '🚀 New Features' + labels: + - ':rocket: feature' + - title: '👻 Bug Fixes' + labels: + - ':ghost: bug' + - title: '⏳ Deprecations' + labels: + - ':file_cabinet: deprecation' + - title: '📃 Documentation' + labels: + - ':book: documentation' + - title: '🧰 Maintenance' + labels: + - ':building_construction: build' + - ':construction_worker_woman: ci' + collapse-after: 5 + - title: '🔬 Other updates' + labels: + - ':nail_care: style' + - ':test_tube: testing' + - ':racing_car: performance' + - ':sparkles: code quality' + - ':sparkles: enhancement' + - title: '🧩 Dependency Updates' + labels: + - ':recycle: dependencies' + collapse-after: 5 +exclude-labels: + - ':arrow_up: bump' + - 'skip-changelog' + +autolabeler: + - label: ':rocket: feature' + title: + - '/adds/i' + - '/add method/i' + - label: ':ghost: bug' + title: + - '/fix/i' + - label: ':sparkles: code quality' + title: + - '/Refactor/i' + - label: ':test_tube: testing' + files: + - 'test_*' + - 'conftest.py' + - label: ':book: documentation' + title: + - '/docs:/i' + files: + - '*.md' + - 'mkdocs.yml' + - label: ':construction_worker_woman: ci' + files: + - '.github/*' + - label: ':recycle: dependencies' + title: + - '/bump/i' + - label: ':file_cabinet: deprecation' + title: + - '/Deprecate/i' + +change-template: '- $TITLE @$AUTHOR (#$NUMBER)' +change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks. +exclude-contributors: + - 'dependabot' + +version-resolver: + major: + labels: + - ':boom: breaking change' + minor: + labels: + - ':rocket: feature' + default: patch + +template: | + ## What's Changed + + $CHANGES + + Contributors: $CONTRIBUTORS + +replacers: + - search: '/(?:and )?@dependabot(?:\[bot\])?,?/g' + replace: '' diff --git a/.github/workflows/draft.yml b/.github/workflows/draft.yml new file mode 100644 index 0000000..23f3b42 --- /dev/null +++ b/.github/workflows/draft.yml @@ -0,0 +1,26 @@ +name: Release Drafter + +on: + push: + branches: + - main + # pull_request event is required only for autolabeler + pull_request: + types: [opened, reopened, synchronize] + pull_request_target: + types: [opened, reopened, synchronize] + +permissions: + contents: read + +jobs: + update-draft: + runs-on: ubuntu-latest + permissions: + contents: write + pull-requests: write + steps: + # Drafts your next Release notes as Pull Requests are merged into "main" + - uses: release-drafter/release-drafter@v6 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}