Skip to content

Commit b78767d

Browse files
authored
CXX-3008 Improve Silk/Snyk post-release instructions with explicit commands (#1151)
1 parent 308468b commit b78767d

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

etc/releasing.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,27 @@ The new branch should be continuously tested on Evergreen. Update the "Display N
315315

316316
After creating the new minor release branch in the prior step, update Silk and Snyk to trach the new release branch.
317317

318-
For Silk, use the [create-silk-asset-group.py script](https://github.com/mongodb/mongo-c-driver/blob/master/tools/create-silk-asset-group.py) in the C Driver to create a new Silk asset group. Use `mongo-cxx-driver` as the name and prefix in place of `mongo-c-driver` accordingly.
318+
For Silk, use the [create-silk-asset-group.py script](https://github.com/mongodb/mongo-c-driver/blob/master/tools/create-silk-asset-group.py) in the C Driver to create a new Silk asset group:
319+
320+
```bash
321+
# Snyk credentials. Ask for these from a team member.
322+
. ~/.secrets/silk-creds.txt.
323+
324+
# Ensure correct release version number!
325+
version="X.Y"
326+
327+
create_args=(
328+
--silk-client-id "${SILK_CLIENT_ID:?}"
329+
--silk-client-secret "${SILK_CLIENT_SECRET:?}"
330+
--asset-id "mongo-cxx-driver-${version:?}" # Avoid '/' in Asset ID field.
331+
--project "mongo-cxx-driver-${version:?}"
332+
--branch "releases/v${version:?}"
333+
--code-repo-url "https://github.com/mongodb/mongo-cxx-driver"
334+
--sbom-lite-path="etc/cyclonedx.sbom.json"
335+
)
336+
337+
python path/to/tools/create-silk-asset-group.py "${create_args[@]:?}"
338+
```
319339

320340
For Snyk, configure and build the CXX Driver with `BSONCXX_POLY_USE_MNMLSTC=ON` (force download of mnmlstc/core sources) and no `CMAKE_PREFIX_PATH` entry to a C Driver installation (force download of C Driver sources), then run:
321341

@@ -324,7 +344,7 @@ For Snyk, configure and build the CXX Driver with `BSONCXX_POLY_USE_MNMLSTC=ON`
324344
. ~/.secrets/snyk-creds.txt
325345

326346
# Name of the new minor release branch. Ensure this is correct!
327-
branch="rX.Y"
347+
branch="releases/vX.Y"
328348

329349
# Authenticate with Snyk dev-prod organization.
330350
snyk auth "${SNYK_API_TOKEN:?}"

0 commit comments

Comments
 (0)