Skip to content

Commit f596655

Browse files
authored
Update SSDLC-related files and release instructions (#1274)
1 parent be9683c commit f596655

File tree

2 files changed

+25
-16
lines changed

2 files changed

+25
-16
lines changed

etc/releasing.md

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,16 @@ See the comment accompanying `MONGOC_VERSION_MINIMUM` for a list of other source
113113
114114
Ensure there are no new or unexpected issues with High severity or greater.
115115
116-
Update the [SSDLC Report spreadsheet](https://docs.google.com/spreadsheets/d/1sp0bLjj29xO9T8BwDIxUk5IPJ493QkBVCJKIgptxEPc/edit?usp=sharing) with any updates to new or known issues.
116+
Triage any outstanding issues using the `Issues: By Snapshot | Outstanding Issues` view, create JIRA tickets if necessary, and update issue fields accordingly.
117+
118+
> [!NOTE]
119+
> The "Classification", "Action", and "MongoDB Final Status" fields should always be updated. The "Ext. Reference" field may refer to a JIRA ticket number or an external issue tracker as appropriate. Use the "Notes" field to document rationale for the "MongoDB Final Status" for issues with Medium severity or higher. Add any additional notes for future reference in the "Comments" field.
120+
121+
Verify that all issues listed in the `Issues: By Snapshot | SSDLC Report (v2)` view have been triaged.
122+
123+
All issues with an Impact level of "High" or greater must have a "MongoDB Final Status" of "Fix Committed" and a corresponding JIRA ticket number in the "Ext. Reference" field.
124+
125+
All issues with an Impact level of "Medium" or greater which do not have a "MongoDB Final Status" of "Fix Committed" must document rationale for its current status in the "Notes" field.
117126
118127
### SBOM Lite
119128
@@ -276,7 +285,7 @@ Commit the updates to `CHANGELOG.md`.
276285
git commit -m 'Update CHANGELOG for X.Y.Z'
277286
```
278287

279-
## Pre-Release Changes PR
288+
### Pre-Release Changes PR
280289

281290
Push the `pre-release-changes` branch to a fork repository and create a PR to merge `pre-release-changes` onto `master`:
282291

@@ -424,28 +433,24 @@ git reset --hard rX.Y.Z
424433
git push -f upstream releases/stable
425434
```
426435

427-
### Upload SSDLC Reports
428-
429-
Navigate to the [C++ Driver SSDLC Reports](https://drive.google.com/drive/folders/1q9RI55trFzHlh8McALSIAbT6ugyn8zlO) folder and update the master spreadsheet.
436+
### Coverity Report
430437

431-
Once complete, make two copies of the spreadsheet.
438+
Export the `Issues: By Snapshot | SSDLC Report (v2)` view as a CSV named `static_analysis-X.Y.Z.csv`.
432439

433-
Rename one copy to: "SSDLC Report: mongo-cxx-driver X.Y.Z". Leave this copy in this folder.
434-
435-
Rename the other copy to: "static_analysis_report-X.Y.Z". Move this copy into the [SSDLC Compliance Files](https://drive.google.com/drive/folders/1_qwTwYyqPL7VjrZOiuyiDYi1y2NYiClS) folder and name it.
440+
### Upload SSDLC Reports
436441

437-
Upload a copy of the `etc/ssdlc_compliance_report.md`, `etc/third_party_vulnerabilities.md`, and `etc/augmented.sbom.json` files. Rename the files with the version number `-X.Y.Z` suffix in their filenames as already done for other files in this folder.
442+
Upload a copy of the `static_analysis-X.Y.Z.csv`, `etc/ssdlc_compliance_report.md`, `etc/third_party_vulnerabilities.md`, and `etc/augmented.sbom.json` files. Rename the files with the version number `-X.Y.Z` suffix in their filenames as already done for other files in this folder.
438443

439444
> [!WARNING]
440445
> Uploading a file into the SSDLC Compliance Files folder is an irreversible action! However, the files may still be renamed. If necessary, rename any accidentally uploaded files to "(Delete Me)" or similar.
441446
442447
Four new files should be present in the [SSDLC Compliance Files](https://drive.google.com/drive/folders/1_qwTwYyqPL7VjrZOiuyiDYi1y2NYiClS) folder following a release `X.Y.Z`:
443448

444449
```
450+
augmented.sbom-X.Y.Z.json
445451
ssdlc_compliance_report-X.Y.Z.md
452+
static_analysis-X.Y.Z.csv
446453
third_party_vulnerabilities-X.Y.Z.md
447-
static_analysis-X.Y.Z
448-
augmented.sbom-X.Y.Z.json
449454
```
450455

451456
## Post-Release Steps
@@ -811,6 +816,10 @@ Sincerely,
811816
The C++ Driver Team
812817
```
813818

819+
### Update the Release Info Spreadsheet
820+
821+
Add an entry to the [C/C++ Release Info](https://docs.google.com/spreadsheets/d/1yHfGmDnbA5-Qt8FX4tKWC5xk9AhzYZx1SKF4AD36ecY) spreadsheet documenting the date, release version, author (of the release), and additional comments.
822+
814823
## Packaging
815824

816825
### vcpkg

etc/ssdlc_compliance_report.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,17 @@
1111
## Tool used to track third party vulnerabilities
1212

1313
- See [Silk](https://us1.app.silk.security/inventory/asset-group/mongodb____DedupedAssetGroup____60640b8853771efe3af5f78ea37af5d1cdd190df) (internal).
14-
- See [C++ Driver - SSDLC Reports](https://drive.google.com/drive/folders/1q9RI55trFzHlh8McALSIAbT6ugyn8zlO) for release-specific reports.
14+
- See [SSDLC Compliance Files: C++ Driver](https://drive.google.com/drive/folders/1_qwTwYyqPL7VjrZOiuyiDYi1y2NYiClS) (internal) for release-specific reports. Available as needed from the MongoDB C++ Driver team.
1515

1616
## Third-Party Dependency Information
1717

1818
- See [etc/augmented.sbom.json](https://github.com/mongodb/mongo-cxx-driver/blob/master/etc/augmented.sbom.json) within the release tarball.
1919
- See [etc/third_party_vulnerabilities.md](https://github.com/mongodb/mongo-cxx-driver/blob/master/etc/third_party_vulnerabilities.md) within the release tarball.
20-
- See [C++ Driver - SSDLC Reports](https://drive.google.com/drive/folders/1q9RI55trFzHlh8McALSIAbT6ugyn8zlO) for release-specific reports.
20+
- See [SSDLC Compliance Files: C++ Driver](https://drive.google.com/drive/folders/1_qwTwYyqPL7VjrZOiuyiDYi1y2NYiClS) (internal) for release-specific reports. Available as needed from the MongoDB C++ Driver team.
2121

2222
## Static Analysis Findings
2323

24-
- See [C++ Driver - SSDLC Reports](https://drive.google.com/drive/folders/1q9RI55trFzHlh8McALSIAbT6ugyn8zlO) for release-specific reports.
24+
- Available as needed from the MongoDB C++ Driver team.
2525

2626
## Security Testing Report
2727

@@ -37,4 +37,4 @@
3737

3838
## Known Vulnerabilities
3939

40-
- Any vulnerabilities that may be shown in the links referenced above have been reviewed and accepted by the appropriate approvers. For detailed information, see [C++ Driver - SSDLC Reports](https://drive.google.com/drive/folders/1q9RI55trFzHlh8McALSIAbT6ugyn8zlO) for release-specific reports.
40+
- Any vulnerabilities that may be shown in the links referenced above have been reviewed and accepted by the appropriate approvers. For more information, see [SSDLC Compliance Files: C++ Driver](https://drive.google.com/drive/folders/1_qwTwYyqPL7VjrZOiuyiDYi1y2NYiClS) (internal) for release-specific reports. Available as needed from the MongoDB C++ Driver team.

0 commit comments

Comments
 (0)