Skip to content

Commit 7402d3d

Browse files
authored
Fix indentation level of CHANGELOG entries (#1281)
* Add pre-release instruction to verify dry-run of etc/make_release.py
1 parent 2a11882 commit 7402d3d

File tree

2 files changed

+11
-5
lines changed

2 files changed

+11
-5
lines changed

CHANGELOG.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -9,24 +9,24 @@ Changes prior to 3.9.0 are documented as [release notes on GitHub](https://githu
99

1010
## 4.0.0
1111

12-
## Added
12+
### Added
1313

1414
- Getter for the `start_at_operation_time` option in `mongocxx::v_noabi::options::change_stream`.
1515

16-
## Changed
16+
### Changed
1717

1818
- Bump the minimum required C Driver version to [1.29.0](https://github.com/mongodb/mongo-c-driver/releases/tag/1.29.0).
1919
- CMake option `ENABLE_TESTS` is now `OFF` by default.
2020
- Set `ENABLE_TEST=ON` to re-enable building test targets.
2121
- Set `BUILD_TESTING=ON` to include test targets in the "all" target when `ENABLE_TESTS=ON` (since 3.9.0, `OFF` by default).
2222
- Layout of `mongocxx::v_noabi::options::change_stream` to support the new optional `start_at_operation_time` accessor.
2323

24-
## Deprecated
24+
### Deprecated
2525

2626
- Support for MongoDB Server 4.0.
2727
- See: [MongoDB Software Lifecycle Schedules](https://www.mongodb.com/legal/support-policy/lifecycles).
2828

29-
## Removed
29+
### Removed
3030

3131
- Support for external polyfill libraries.
3232
- `ENABLE_BSONCXX_POLY_USE_IMPLS=ON` is now implicit behavior.

etc/releasing.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -255,6 +255,12 @@ Update the contents of related Jira tickets as appropriate (improve the title, c
255255
> A ticket whose changes may impact users should either be a "Bug" or "New Feature".
256256
> Otherwise, the ticket should typically be a "Task".
257257
258+
### Dry-run etc/make_release.py
259+
260+
Perform a dry-run of the "Run etc/make_release.py" steps described below.
261+
262+
Verify there are no unexpected errors or issues.
263+
258264
## Release Steps
259265

260266
### Update CHANGELOG...
@@ -411,9 +417,9 @@ Run the release script with the git tag created above as an argument and
411417

412418
```bash
413419
make_release_args=(
420+
-r upstream
414421
--jira-creds-file ~/.secrets/jira-creds.txt
415422
--github-token-file ~/.secrets/github-token.txt
416-
-r upstream # Only if mongodb/mongo-cxx-driver is not "origin".
417423
)
418424
python ./etc/make_release.py "${make_release_args[@]:?}" --dry-run rX.Y.Z
419425
```

0 commit comments

Comments
 (0)