1
- ## Releasing
1
+ # Releasing
2
2
3
3
The following steps outline the release process for both new minor versions (e.g.
4
4
releasing the ` master ` branch as X.Y.0) and patch versions (e.g. releasing the
@@ -13,11 +13,11 @@ It helps to keep your own fork in sync with the "mongodb" repository (i.e. any
13
13
branches and tags on the main repository should also exist in your fork). This
14
14
is left as an exercise to the reader.
15
15
16
- ### Ensure PHP version compatibility
16
+ ## Ensure PHP version compatibility
17
17
18
18
Ensure that the library test suite completes on supported versions of PHP.
19
19
20
- ### Transition JIRA issues and version
20
+ ## Transition JIRA issues and version
21
21
22
22
All issues associated with the release version should be in the "Closed" state
23
23
and have a resolution of "Fixed". Issues with other resolutions (e.g.
@@ -31,7 +31,7 @@ Update the version's release date and status from the
31
31
[ Manage Versions] ( https://jira.mongodb.org/plugins/servlet/project-config/PHPLIB/versions )
32
32
page.
33
33
34
- ### Update version info
34
+ ## Update version info
35
35
36
36
The PHP library uses [ semantic versioning] ( https://semver.org/ ) . Do not break
37
37
backwards compatibility in a non-major release or your users will kill you.
@@ -41,7 +41,7 @@ changes in this maintenance branch. This is important because we will later
41
41
merge the ensuing release commits up to master with ` --strategy=ours ` , which
42
42
will ignore changes from the merged commits.
43
43
44
- ### Update composer.json and CI matrices
44
+ ## Update composer.json and CI matrices
45
45
46
46
This is especially important before releasing a new minor version.
47
47
@@ -81,7 +81,7 @@ $ git commit -m "Update composer.json and CI matrices for X.Y.Z" composer.json .
81
81
$ git push mongodb
82
82
```
83
83
84
- ### Tag the release
84
+ ## Tag the release
85
85
86
86
Create a tag for the release and push:
87
87
@@ -90,9 +90,9 @@ $ git tag -a -m "Release X.Y.Z" X.Y.Z
90
90
$ git push mongodb --tags
91
91
```
92
92
93
- ### Branch management
93
+ ## Branch management
94
94
95
- ## Creating a maintenance branch and updating master branch alias
95
+ # Creating a maintenance branch and updating master branch alias
96
96
97
97
After releasing a new major or minor version (e.g. 1.9.0), a maintenance branch
98
98
(e.g. v1.9) should be created. Any development towards a patch release (e.g.
@@ -123,7 +123,7 @@ Commit this change:
123
123
$ git commit -m "Master is now 1.10-dev" composer.json
124
124
```
125
125
126
- #### After releasing a new minor version
126
+ ### After releasing a new minor version
127
127
128
128
After a new minor version is released (i.e. ` master ` was tagged), a maintenance
129
129
branch should be created for future patch releases:
@@ -151,7 +151,7 @@ $ git commit -m "Master is now X.Y-dev" composer.json
151
151
$ git push mongodb
152
152
```
153
153
154
- #### After releasing a patch version
154
+ ### After releasing a patch version
155
155
156
156
If this was a patch release, the maintenance branch must be merged up to master:
157
157
@@ -168,7 +168,7 @@ branch was up-to-date with all code changes in this maintenance branch before
168
168
tagging.
169
169
170
170
171
- ### Publish release notes
171
+ ## Publish release notes
172
172
173
173
The following template should be used for creating GitHub release notes via
174
174
[ this form] ( https://github.com/mongodb/mongo-php-library/releases/new ) .
@@ -212,7 +212,7 @@ Thanks for our community contributors for this release:
212
212
213
213
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.
214
214
215
- ### Documentation Updates for New Major and Minor Versions
215
+ ## Documentation Updates for New Major and Minor Versions
216
216
217
217
New major and minor releases will also require documentation updates to other
218
218
projects:
0 commit comments