Skip to content

Commit 8d8573e

Browse files
committed
Update contribution docs to include steps for bumping libmongoc
1 parent f710b7b commit 8d8573e

File tree

1 file changed

+25
-3
lines changed

1 file changed

+25
-3
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -172,10 +172,18 @@ If something goes awry in the test VM, you can reload it by running:
172172
make test-bootstrap
173173
```
174174

175-
## Releasing
175+
## Updating libmongoc and libbson
176176

177-
The follow steps outline the release process for a maintenance branch (e.g.
178-
releasing the `vX.Y` branch as X.Y.Z).
177+
The PHP driver uses a bundled version of libmongoc and libbson. If a new version
178+
of libmongoc is available, the submodule needs to be updated.
179+
180+
### Update libmongoc to the latest version
181+
182+
```
183+
$ cd src/libmongoc
184+
$ git fetch
185+
$ git checkout 1.15.0
186+
```
179187

180188
### Ensure libmongoc version information is correct
181189

@@ -190,6 +198,20 @@ $ make libmongoc-version-current
190198
Alternatively, the `build/calc_release_version.py` script in libmongoc can be
191199
executed directly.
192200

201+
### Test and commit your changes
202+
203+
Once you have verified that all tests pass, commit the changes to the submodule
204+
and `src/LIBMONGOC_VERSION_CURRENT`:
205+
206+
```
207+
$ git commit -m "Bump libmongoc to 1.15.0" src/LIBMONGOC_VERSION_CURRENT src/libmongoc
208+
```
209+
210+
## Releasing
211+
212+
The follow steps outline the release process for a maintenance branch (e.g.
213+
releasing the `vX.Y` branch as X.Y.Z).
214+
193215
### Ensure PHP version compatibility
194216

195217
Ensure that the extension compiles on PHP 5.6 through the latest PHP 7.x

0 commit comments

Comments
 (0)