Skip to content

Commit

Permalink
Fix indentation level of CHANGELOG entries (#1281)
Browse files Browse the repository at this point in the history
* Add pre-release instruction to verify dry-run of etc/make_release.py
  • Loading branch information
eramongodb authored Nov 20, 2024
1 parent 2a11882 commit 7402d3d
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 5 deletions.
8 changes: 4 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,24 @@ Changes prior to 3.9.0 are documented as [release notes on GitHub](https://githu

## 4.0.0

## Added
### Added

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

## Changed
### Changed

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

## Deprecated
### Deprecated

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

## Removed
### Removed

- Support for external polyfill libraries.
- `ENABLE_BSONCXX_POLY_USE_IMPLS=ON` is now implicit behavior.
Expand Down
8 changes: 7 additions & 1 deletion etc/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,12 @@ Update the contents of related Jira tickets as appropriate (improve the title, c
> A ticket whose changes may impact users should either be a "Bug" or "New Feature".
> Otherwise, the ticket should typically be a "Task".
### Dry-run etc/make_release.py

Perform a dry-run of the "Run etc/make_release.py" steps described below.

Verify there are no unexpected errors or issues.

## Release Steps

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

```bash
make_release_args=(
-r upstream
--jira-creds-file ~/.secrets/jira-creds.txt
--github-token-file ~/.secrets/github-token.txt
-r upstream # Only if mongodb/mongo-cxx-driver is not "origin".
)
python ./etc/make_release.py "${make_release_args[@]:?}" --dry-run rX.Y.Z
```
Expand Down

0 comments on commit 7402d3d

Please sign in to comment.