Skip to content

Update CHANGELOG with 3.10.2 entries #1187

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 4 commits into from
Aug 6, 2024
Merged

Update CHANGELOG with 3.10.2 entries #1187

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d8e3042
Update CHANGELOG with 3.10.2 entries
eramongodb Aug 6, 2024
7393fc8
Update post-patch-release instructions for CHANGELOG entries
eramongodb Aug 6, 2024
dbd98df
Edit instructions to account for pre-existing patch entries
eramongodb Aug 6, 2024
a35f2c9
Wording tweaks
eramongodb Aug 6, 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
12 changes: 11 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,20 @@ Changes prior to 3.9.0 are documented as [release notes on GitHub](https://githu
- A future minor release plans to raise the minimum supported MongoDB Server version from 3.6 to 4.0. This is in
accordance with [MongoDB Software Lifecycle Schedules](https://www.mongodb.com/legal/support-policy/lifecycles).

## 3.10.2 [Unreleased]
## 3.10.3 [Unreleased]

<!-- Will contain entries for the next patch release -->

## 3.10.2

### Added

- SSDLC Compliance Report and related release artifacts.

### Fixed

- Undefined behavior when moving a `mongocxx::v_noabi::events::topology_description::server_descriptions` object due to uninitialized data member access.

## 3.10.1

### Fixed
Expand Down
24 changes: 24 additions & 0 deletions etc/releasing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -671,6 +671,30 @@ Add a section for the next patch release, e.g. following a `1.2.3` release:

Commit the changes to the `releases/vX.Y` branch and push the branch to the remote repository (a PR is not required for this step).

Checkout the `post-release-changes` branch.

Sync the entries in the patch release section to be consistent with the entries on the release branch, e.g. following a `1.2.3` release:

```md
## 1.3.0 [Unreleased]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## 1.3.0 [Unreleased]
## 1.2.4 [Unreleased]

Copy link
Contributor Author

@eramongodb eramongodb Aug 6, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1.3.0 is correct because this code block corresponds to the CHANGELOG.md on master, not the release branch (as in earlier instructions above).

Do we expect / want to maintain patch release notes on master prior to patch releases? IIRC we avoid doing so to avoid potential cherry-pick conflicts with the release branch.

Copy link
Contributor Author

@eramongodb eramongodb Aug 6, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On further thought, I believe the expectation is yes (with caveats) given the "Important" note added in #1161 concerning shifting of entries from an unreleased patch section -> next unreleased minor section.

Revised the instructions accordingly.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe the expectation is yes

I think so too. The CHANGELOG.md on master included ## 3.10.2 [Unreleased] (which this PR updates).


<!-- Will contain entries for the next minor release. -->
<!-- Ensure any existing entries are not removed during the sync. -->

## 1.2.4 [Unreleased]

<!-- Will contain entries for the next patch release. -->

## 1.2.3 <!-- Just released. -->

<!-- Ensure these entries match those in the release. -->

## 1.2.2 <!-- Prior release. -->
```

> [!TIP]
> Use `git restore --source=rX.Y.Z --worktree CHANGELOG.md` to obtain the `CHANGELOG.md` in `rX.Y.Z` as unstaged changes.

#### ... for a Non-Patch Release

Checkout the `post-release-changes` branch.
Expand Down