You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: RELEASING.md
+7-46Lines changed: 7 additions & 46 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,15 +3,6 @@
3
3
The following steps outline the release process for both new minor versions and
4
4
patch versions.
5
5
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
-
15
6
## Ensure PHP version compatibility
16
7
17
8
Ensure that the test suite completes on supported versions of PHP.
@@ -35,52 +26,22 @@ page.
35
26
36
27
Releases are done automatically through a GitHub Action. Visit the corresponding
37
28
[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`)
39
30
and trigger a new run using the "Run workflow" button. In the following prompt,
40
31
enter the version number.
41
32
42
33
The automation will then create and push the necessary commits and tag, and create
43
34
a draft release. The release is created in a draft state and can be published
44
35
once the release notes have been updated.
45
36
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
-
82
37
## Publish release notes
83
38
84
39
Use the generated release note in [this form](https://github.com/mongodb/laravel-mongodb/releases/new).
85
40
86
41
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.
0 commit comments