Commit a307dd60 authored by Jeremy Mikola's avatar Jeremy Mikola

Document process for merging branches after a release

parent fd42cf02
...@@ -95,6 +95,11 @@ page. ...@@ -95,6 +95,11 @@ page.
The PHP library uses [semantic versioning](http://semver.org/). Do not break The PHP library uses [semantic versioning](http://semver.org/). Do not break
backwards compatibility in a non-major release or your users will kill you. backwards compatibility in a non-major release or your users will kill you.
Before proceeding, ensure that the `master` 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 up to master with `--strategy=ours`, which
will ignore changes from the merged commits.
A version constant may be added at a later date (see: A version constant may be added at a later date (see:
[PHPLIB-131](https://jira.mongodb.org/browse/PHPLIB-131)). For now, there is [PHPLIB-131](https://jira.mongodb.org/browse/PHPLIB-131)). For now, there is
nothing to update. nothing to update.
...@@ -113,6 +118,17 @@ $ git tag -a -m "Release X.Y.Z" X.Y.Z ...@@ -113,6 +118,17 @@ $ git tag -a -m "Release X.Y.Z" X.Y.Z
$ git push --tags $ git push --tags
``` ```
### Merge the maintenance branch up to master
```
$ git checkout master
$ git merge vX.Y --strategy=ours
$ git push
```
The `--strategy=ours` option ensures that all changes from the merged commits
will be ignored.
### Publish release notes ### Publish release notes
The following template should be used for creating GitHub release notes via The following template should be used for creating GitHub release notes via
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment