diff --git a/.github/release-draft-template.yml b/.github/release-draft-template.yml deleted file mode 100644 index 9c6080c0b..000000000 --- a/.github/release-draft-template.yml +++ /dev/null @@ -1,29 +0,0 @@ -name-template: 'v$RESOLVED_VERSION' -tag-template: 'v$RESOLVED_VERSION' -exclude-labels: - - 'skip changelog' -version-resolver: - minor: - labels: - - 'enhancement' - default: patch -categories: - - title: '⚠️ Breaking changes' - label: 'breaking-change' - - title: '🚀 Enhancements' - label: 'enhancement' - - title: '🐛 Bug Fixes' - label: 'bug' - - title: '🔒 Security' - label: 'security' - - title: '⚙️ Maintenance/misc' - label: - - 'dependencies' - - 'maintenance' - - 'documentation' -template: | - $CHANGES - - ❤️ Huge thanks to our contributors: $CONTRIBUTORS. -no-changes-template: 'Changes are coming soon 😎' -sort-direction: 'ascending' diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml deleted file mode 100644 index 2f8ec04b0..000000000 --- a/.github/workflows/release-drafter.yml +++ /dev/null @@ -1,20 +0,0 @@ -name: Release Drafter - -permissions: - contents: read - pull-requests: write - -on: - push: - branches: - - main - -jobs: - update_release_draft: - runs-on: ubuntu-latest - steps: - - uses: release-drafter/release-drafter@v6 - with: - config-name: release-draft-template.yml - env: - GITHUB_TOKEN: ${{ secrets.RELEASE_DRAFTER_TOKEN }} diff --git a/documentation/release.md b/documentation/release.md index b3d0ed7e9..12856411f 100644 --- a/documentation/release.md +++ b/documentation/release.md @@ -58,6 +58,12 @@ Why? GitHub Merge Queue does not work with branch patterns yet, so we have to ad 5. Go to the GitHub interface, in the [`Release` section](https://github.com/meilisearch/meilisearch/releases) and click on `Draft a new release` ⚠️⚠️⚠️ Publish on `release-vX.Y.Z+1` branch, not on `main`! +📝 About the changelogs +- Use the "Generate release notes" button in the GitHub interface to get the exhaustive list of PRs. +- Separate the PRs into different categories: Enhancement/Features, Bug fixes, Maintenance. +- Ensure each line makes sense for external people reading the changelogs. Add more details of usage if needed. +- Thank the external contributors at the end of the changelogs. + ⚠️ If doing a patch release that should NOT be the `latest` release: - Do NOT check `Set as the latest release` when creating the GitHub release. If you did, quickly interrupt all CIs and delete the GitHub release!