Skip to content

Commit c9d19ad

Browse files
authored
Update RELEASING.md (#2990)
1 parent 57b76b4 commit c9d19ad

File tree

1 file changed

+9
-15
lines changed

1 file changed

+9
-15
lines changed

RELEASING.md

+9-15
Original file line numberDiff line numberDiff line change
@@ -31,24 +31,18 @@ Update the version's release date and status from the
3131
[Manage Versions](https://jira.mongodb.org/plugins/servlet/project-config/PHPORM/versions)
3232
page.
3333

34-
## Update version info
34+
## Trigger the release workflow
3535

36-
This uses [semantic versioning](https://semver.org/). Do not break
37-
backwards compatibility in a non-major release or your users will kill you.
36+
Releases are done automatically through a GitHub Action. Visit the corresponding
37+
[Release New Version](https://github.com/mongodb/laravel-mongodb/actions/workflows/release.yml)
38+
workflow page to trigger a new build. Select the correct branch (e.g. `v4.5`)
39+
and trigger a new run using the "Run workflow" button. In the following prompt,
40+
enter the version number.
3841

39-
Before proceeding, ensure that the default branch is up-to-date with all code
40-
changes in this maintenance branch. This is important because we will later
41-
merge the ensuing release commits with `--strategy=ours`, which will ignore
42-
changes from the merged commits.
42+
The automation will then create and push the necessary commits and tag, and create
43+
a draft release. The release is created in a draft state and can be published
44+
once the release notes have been updated.
4345

44-
## Tag the release
45-
46-
Create a tag for the release and push:
47-
48-
```console
49-
$ git tag -a -m "Release X.Y.Z" X.Y.Z
50-
$ git push mongodb --tags
51-
```
5246

5347
## Branch management
5448

0 commit comments

Comments
 (0)