From 3d7b3126d77bb5699698bfd24605ccc80c5ef645 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Tamarelle?= Date: Fri, 31 May 2024 13:51:02 +0200 Subject: [PATCH 1/2] Update RELEASING.md --- RELEASING.md | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/RELEASING.md b/RELEASING.md index c4aeecd39..f29575092 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -31,24 +31,18 @@ Update the version's release date and status from the [Manage Versions](https://jira.mongodb.org/plugins/servlet/project-config/PHPORM/versions) page. -## Update version info +## Choose a version This uses [semantic versioning](https://semver.org/). Do not break backwards compatibility in a non-major release or your users will kill you. -Before proceeding, ensure that the default branch is up-to-date with all code -changes in this maintenance branch. This is important because we will later -merge the ensuing release commits with `--strategy=ours`, which will ignore -changes from the merged commits. +## Create the release with GitHub Action -## Tag the release +Go to the [Release New Version](https://github.com/mongodb/laravel-mongodb/actions/workflows/release.yml) action an click on "Run workflow". -Create a tag for the release and push: +Select the branch to release, the new version number and click "Run workflow". -```console -$ git tag -a -m "Release X.Y.Z" X.Y.Z -$ git push mongodb --tags -``` +The GitHub Action will create the tag and a draft release. Update and publish the release. ## Branch management From 21bfc7b58bccb03e90e3bcd64fe53a6744986109 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Tamarelle?= Date: Tue, 4 Jun 2024 14:29:41 +0200 Subject: [PATCH 2/2] Import release process from PHPC --- RELEASING.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/RELEASING.md b/RELEASING.md index f29575092..4be9302a4 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -31,18 +31,18 @@ Update the version's release date and status from the [Manage Versions](https://jira.mongodb.org/plugins/servlet/project-config/PHPORM/versions) page. -## Choose a version +## Trigger the release workflow -This uses [semantic versioning](https://semver.org/). Do not break -backwards compatibility in a non-major release or your users will kill you. +Releases are done automatically through a GitHub Action. Visit the corresponding +[Release New Version](https://github.com/mongodb/laravel-mongodb/actions/workflows/release.yml) +workflow page to trigger a new build. Select the correct branch (e.g. `v4.5`) +and trigger a new run using the "Run workflow" button. In the following prompt, +enter the version number. -## Create the release with GitHub Action +The automation will then create and push the necessary commits and tag, and create +a draft release. The release is created in a draft state and can be published +once the release notes have been updated. -Go to the [Release New Version](https://github.com/mongodb/laravel-mongodb/actions/workflows/release.yml) action an click on "Run workflow". - -Select the branch to release, the new version number and click "Run workflow". - -The GitHub Action will create the tag and a draft release. Update and publish the release. ## Branch management