You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* bump SBOM `serialNumber`
* tweak release steps:
** always generate new SBOM serial number on release branch.
*** step previously noted only during a minor release.
** replace `minor` with `non-patch`
*** to clarify that steps apply for a minor or major release.
* only generate SBOM serial number on `master` following a non-patch release.
Copy file name to clipboardExpand all lines: doc/releasing.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ Go to [Snyk](https://app.snyk.io/) and select the `dev-prod` organization. If ac
19
19
20
20
##### Update Snyk
21
21
22
-
Update the Snyk reference target tracking the to-be-released branch. For a patch release (e.g. x.y.z), check-out the `rx.y` branch and update the `rx.y` reference target. For a minor release (e.g. x.y.0), check out the `master` branch and update the `master` reference target.
22
+
Update the Snyk reference target tracking the to-be-released branch. For a patch release (e.g. x.y.z), check-out the `rx.y` branch and update the `rx.y` reference target. For a non-patch release (e.g. x.y.0), check out the `master` branch and update the `master` reference target.
23
23
24
24
Run `cmake` to ensure generated source files are present:
25
25
```bash
@@ -61,11 +61,11 @@ Check the contents of the "vulnerabilities" field (if present) in the Augmented
61
61
62
62
Do the following when releasing:
63
63
- If this is a feature release (e.g. `x.y.0` or `x.0.0`), follow these steps: [Creating SSDLC static analysis reports](https://docs.google.com/document/d/1rkFL8ymbkc0k8Apky9w5pTPbvKRm68wj17mPJt2_0yo/edit).
64
-
- Check out the release branch. For a release `x.y.z`, the release branch is `rx.y`. If this is a new minor release (`x.y.0`), create the release branch.
64
+
- Check out the release branch. For a release `x.y.z`, the release branch is `rx.y`. If this is a new non-patch release (`x.y.0`), create the release branch.
65
65
- Update CHANGELOG.md with the version being released.
66
66
- Ensure `etc/purls.txt` is up-to-date.
67
67
- Update `etc/third_party_vulnerabilities.md` with any updates to new or known vulnerabilities for third party dependencies that must be reported.
68
-
- If this is a new minor release (e.g. `x.y.0`):
68
+
- If this is a new non-patch release (e.g. `x.y.0`):
69
69
- Update the Linux distribution package installation instructions in [README.md](../README.md) to refer to the new version `x.y`.
70
70
- Update the [libmongocrypt-release](https://spruce.mongodb.com/project/libmongocrypt-release/settings/general) Evergreen project (requires auth) to set `Branch Name` to `rx.y`.
71
71
- Commit the changes on the `rx.y` branch with a message like "Release x.y.z".
@@ -84,14 +84,13 @@ Do the following when releasing:
84
84
Download the Augmented SBOM from a recent execution of the `sbom` task in an Evergreen patch or commit build.
85
85
- Attach `etc/third_party_vulnerabilities.md` to the release.
86
86
- Attach `etc/ssdlc_compliance_report.md` to the release.
87
-
88
-
- If this is a new minor release (e.g. `x.y.0`):
87
+
- Check out the release branch (`rx.y`). Generate a new unique SBOM serial number for the next upcoming patch release (e.g. for `1.13.1` following the release of `1.13.0`):
Commit resulting `etc/cyclonedx.sbom.json` and push to `rx.y`.
92
+
- If this is a new non-patch release (e.g. `x.y.0`):
89
93
- File a DOCSP ticket to update the installation instructions on [Install libmongocrypt](https://www.mongodb.com/docs/manual/core/csfle/reference/libmongocrypt/). ([Example](https://jira.mongodb.org/browse/DOCSP-47954))
90
-
- Check out the release branch (`rx.y`). Generate a new unique SBOM serial number for the next upcoming patch release (e.g. for `1.13.1` following the release of `1.13.0`):
Commit resulting `etc/cyclonedx.sbom.json` and push to `rx.y`.
95
94
- Create a new Snyk reference target. The following instructions use the example branch `rx.y`:
96
95
97
96
Run `cmake` to ensure generated source files are present:
@@ -121,7 +120,7 @@ Do the following when releasing:
121
120
- Add the new release branch to the `Payload URL`. Remove unmaintained release branches.
122
121
- Make a PR to to the `master` branch:
123
122
- Apply changes from the "Release x.y.z" commit.
124
-
- Generate a new unique SBOM serial number next upcoming non-patch release (e.g. for`1.14.0` following the release of `1.13.0`):
123
+
- If this was a non-patch release (e.g. `x.y.0`), generate a new unique SBOM serial numberfor the next upcoming non-patch release (e.g. for`1.14.0` following the release of `1.13.0`):
@@ -132,13 +131,14 @@ Do the following when releasing:
132
131
133
132
## Homebrew steps ##
134
133
Submit a PR to update the Homebrew package https://github.com/mongodb/homebrew-brew/blob/master/Formula/libmongocrypt.rb. ([Example](https://github.com/mongodb/homebrew-brew/pull/234)). If not on macOS, request a team member to do this step.
134
+
Request review by posting in#ask-devprod-build.
135
135
136
136
## Debian steps ##
137
137
If you are not a Debian maintainer on the team, request a team member to do the steps in this section.
138
138
139
139
Refer to the [Debian](https://github.com/mongodb/mongo-c-driver/blob/master/docs/dev/debian.rst) steps.
140
140
141
-
For a minor release (e.g. x.y.0), submit a merge request to the [extrepo-data](https://salsa.debian.org/extrepo-team/extrepo-data) project in Debian to update the PPA. The change would look something like this:
141
+
For a non-patch release (e.g. x.y.0), submit a merge request to the [extrepo-data](https://salsa.debian.org/extrepo-team/extrepo-data) project in Debian to update the PPA. The change would look something like this:
0 commit comments