Skip to content

Fix indentation level of CHANGELOG entries #1281

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 20, 2024
Merged

Fix indentation level of CHANGELOG entries #1281

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a3a3ff2
Fix indentation level of CHANGELOG entries
eramongodb Nov 20, 2024
b4e89c2
Add pre-release instruction to verify dry-run of etc/make_release.py
eramongodb Nov 20, 2024
21337ac
Remove redundant instruction for workaround of open release tickets
eramongodb Nov 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions CHANGELOG.md
View file
Open in desktop
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
View file
Open in desktop
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