From c9d19ad06028755f11f0912e0748dd225999d5d4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Tamarelle?= Date: Tue, 4 Jun 2024 15:11:04 +0200 Subject: [PATCH] Update RELEASING.md (#2990) --- RELEASING.md | 24 +++++++++--------------- 1 file changed, 9 insertions(+), 15 deletions(-) diff --git a/RELEASING.md b/RELEASING.md index c4aeecd39..4be9302a4 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 +## 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. -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. +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. -## Tag the release - -Create a tag for the release and push: - -```console -$ git tag -a -m "Release X.Y.Z" X.Y.Z -$ git push mongodb --tags -``` ## Branch management