Skip to content

Commit 3b856e6

Browse files
committed
CXX-3008 add instructions to examine Snyk reports during release (#1139)
* Also pin dependencies in etc/requirements.txt
1 parent 2a41197 commit 3b856e6

File tree

2 files changed

+37
-7
lines changed

2 files changed

+37
-7
lines changed

etc/releasing.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ by changes in the new release.
2121

2222
## Check Coverity
2323

24-
Ensure there are no new, unexpected, or high severity issues on Coverity.
24+
Ensure there are no new or unexpected issues with High severity or greater.
2525

2626
## Update etc/purls.txt
2727

@@ -37,6 +37,14 @@ podman login artifactory.corp.mongodb.com --username cpp-driver
3737
podman run -it --rm -v "$(pwd):$(pwd)" artifactory.corp.mongodb.com/release-tools-container-registry-public-local/silkbomb:1.0 update -p "$(pwd)/etc/purls.txt" -i "$(pwd)/etc/cyclonedx.sbom.json" -o "$(pwd)/etc/cyclonedx.sbom.json"
3838
```
3939

40+
## Check Snyk
41+
42+
Inspect the list of issues in the latest report for the mongodb/mongo-cxx-driver target in [Snyk](https://app.snyk.io/).
43+
44+
Examine the latest report and ensure there are no new or unexpected fixable issues with High severity or greater.
45+
46+
Deactivate any projects that will not be relevant in the upcoming release. Remove any projects that are not relevant to the current release.
47+
4048
## Check fixVersions in Jira
4149

4250
Ensure that all tickets under the

etc/requirements.txt

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,31 @@
1-
# Required for release script.
2-
Click
3-
GitPython
4-
PyGithub
1+
# Required packages for the release script.
2+
click==8.1.7
3+
GitPython==3.1.43
4+
PyGithub==2.3.0
5+
cryptography==42.0.7
6+
57
# Pin `jira` to apply fix of https://github.com/pycontribs/jira/commit/010223289eb66663aaafb70447397038efb2d40d.
68
# This avoids the `signature_method_rejected` error described in https://github.com/pycontribs/jira/pull/1643.
79
# TODO: replace the following line with `jira` once there is a release of `jira` containing the fix.
8-
git+https://github.com/pycontribs/jira.git@010223289eb66663aaafb70447397038efb2d40d
9-
cryptography
10+
jira @ git+https://github.com/pycontribs/jira.git@010223289eb66663aaafb70447397038efb2d40d
11+
12+
# Dependencies of required packages above.
13+
certifi==2024.2.2
14+
cffi==1.16.0
15+
charset-normalizer==3.3.2
16+
defusedxml==0.7.1
17+
Deprecated==1.2.14
18+
gitdb==4.0.11
19+
idna==3.7
20+
oauthlib==3.2.2
21+
packaging==24.0
22+
pycparser==2.22
23+
PyJWT==2.8.0
24+
PyNaCl==1.5.0
25+
requests==2.32.2
26+
requests-oauthlib==2.0.0
27+
requests-toolbelt==1.0.0
28+
smmap==5.0.1
29+
typing_extensions==4.11.0
30+
urllib3==2.2.1
31+
wrapt==1.16.0

0 commit comments

Comments
 (0)