From b85e33b9e46206d43db654ffe44f9450eb8926c3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Tamarelle?= Date: Thu, 23 May 2024 10:56:20 +0200 Subject: [PATCH] Customize generated release notes --- .github/release.yml | 21 +++++++++++++++++++++ RELEASING.md | 40 +--------------------------------------- 2 files changed, 22 insertions(+), 39 deletions(-) create mode 100644 .github/release.yml diff --git a/.github/release.yml b/.github/release.yml new file mode 100644 index 000000000..aabd8e4f2 --- /dev/null +++ b/.github/release.yml @@ -0,0 +1,21 @@ +changelog: + exclude: + labels: + - ignore-for-release + - minor + authors: + - mongodb-php-bot + categories: + - title: Breaking Changes 🛠 + labels: + - breaking-change + - title: New Features + labels: + - enhancement + - title: Fixed + labels: + - bug + - fixed + - title: Other Changes + labels: + - "*" diff --git a/RELEASING.md b/RELEASING.md index e0b494d08..c4aeecd39 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -87,44 +87,6 @@ tagging. ## Publish release notes -The following template should be used for creating GitHub release notes via -[this form](https://github.com/mongodb/laravel-mongodb/releases/new). - -```markdown -The PHP team is happy to announce that version X.Y.Z of the MongoDB integration for Laravel is now available. - -**Release Highlights** - - - -A complete list of resolved issues in this release may be found in [JIRA]($JIRA_URL). - -**Documentation** - -Documentation for this library may be found in the [Readme](https://github.com/mongodb/laravel-mongodb/blob/$VERSION/README.md). - -**Installation** - -This library may be installed or upgraded with: - - composer require mongodb/laravel-mongodb:X.Y.Z - -Installation instructions for the `mongodb` extension may be found in the [PHP.net documentation](https://php.net/manual/en/mongodb.installation.php). -``` - -The URL for the list of resolved JIRA issues will need to be updated with each -release. You may obtain the list from -[this form](https://jira.mongodb.org/secure/ReleaseNote.jspa?projectId=22488). - -If commits from community contributors were included in this release, append the -following section: - -```markdown -**Thanks** - -Thanks for our community contributors for this release: - - * [$CONTRIBUTOR_NAME](https://github.com/$GITHUB_USERNAME) -``` +Use the generated release note in [this form](https://github.com/mongodb/laravel-mongodb/releases/new). Release announcements should also be posted in the [MongoDB Product & Driver Announcements: Driver Releases](https://mongodb.com/community/forums/tags/c/announcements/driver-releases/110/php) forum and shared on Twitter.