Skip to content

Commit 55c8576

Browse files
authored
Remove manual branch management steps from RELEASING.md (#3523)
Branch creation for new minor/major versions is handled by release.yml, and merge-up after patch releases is automated by merge-up.yml.
1 parent c372bc4 commit 55c8576

1 file changed

Lines changed: 7 additions & 46 deletions

File tree

RELEASING.md

Lines changed: 7 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,6 @@
33
The following steps outline the release process for both new minor versions and
44
patch versions.
55

6-
The command examples below assume that the canonical "mongodb" repository has
7-
the remote name "mongodb". You may need to adjust these commands if you've given
8-
the remote another name (e.g. "upstream"). The "origin" remote name was not used
9-
as it likely refers to your personal fork.
10-
11-
It helps to keep your own fork in sync with the "mongodb" repository (i.e. any
12-
branches and tags on the main repository should also exist in your fork). This
13-
is left as an exercise to the reader.
14-
156
## Ensure PHP version compatibility
167

178
Ensure that the test suite completes on supported versions of PHP.
@@ -35,52 +26,22 @@ page.
3526

3627
Releases are done automatically through a GitHub Action. Visit the corresponding
3728
[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`)
29+
workflow page to trigger a new build. Select the correct branch (e.g. `4.5`)
3930
and trigger a new run using the "Run workflow" button. In the following prompt,
4031
enter the version number.
4132

4233
The automation will then create and push the necessary commits and tag, and create
4334
a draft release. The release is created in a draft state and can be published
4435
once the release notes have been updated.
4536

46-
47-
## Branch management
48-
49-
# Creating a maintenance branch and updating default branch name
50-
51-
When releasing a new major or minor version (e.g. 4.0.0), the default branch
52-
should be renamed to the next version (e.g. 4.1). Renaming the default branch
53-
using GitHub's UI ensures that all open pull request are changed to target the
54-
new version.
55-
56-
Once the default branch has been renamed, create the maintenance branch for the
57-
version to be released (e.g. 4.0):
58-
59-
```console
60-
$ git checkout -b X.Y
61-
$ git push mongodb X.Y
62-
```
63-
64-
### After releasing a patch version
65-
66-
If this was a patch release, the maintenance branch must be merged up to the
67-
default branch (e.g. 4.1):
68-
69-
```console
70-
$ git checkout 4.1
71-
$ git pull mongodb 4.1
72-
$ git merge 4.0 --strategy=ours
73-
$ git push mongodb
74-
```
75-
76-
The `--strategy=ours` option ensures that all changes from the merged commits
77-
will be ignored. This is OK because we previously ensured that the `4.1`
78-
branch was up-to-date with all code changes in this maintenance branch before
79-
tagging.
80-
81-
8237
## Publish release notes
8338

8439
Use the generated release note in [this form](https://github.com/mongodb/laravel-mongodb/releases/new).
8540

8641
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.
42+
43+
## Mark JIRA version as released
44+
45+
Mark the version as released from the
46+
[Manage Versions](https://jira.mongodb.org/plugins/servlet/project-config/PHPORM/versions)
47+
page.

0 commit comments

Comments
 (0)