Skip to content

Commit c62aa50

Browse files
committed
CXX-3008 Improve Silk/Snyk post-release instructions with explicit commands (#1151)
1 parent 1f9a7bc commit c62aa50

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
@@ -274,7 +274,27 @@ The new branch should be continuously tested on Evergreen. Update the "Display N
274274

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

277-
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.
277+
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:
278+
279+
```bash
280+
# Snyk credentials. Ask for these from a team member.
281+
. ~/.secrets/silk-creds.txt.
282+
283+
# Ensure correct release version number!
284+
version="X.Y"
285+
286+
create_args=(
287+
--silk-client-id "${SILK_CLIENT_ID:?}"
288+
--silk-client-secret "${SILK_CLIENT_SECRET:?}"
289+
--asset-id "mongo-cxx-driver-${version:?}" # Avoid '/' in Asset ID field.
290+
--project "mongo-cxx-driver-${version:?}"
291+
--branch "releases/v${version:?}"
292+
--code-repo-url "https://github.com/mongodb/mongo-cxx-driver"
293+
--sbom-lite-path="etc/cyclonedx.sbom.json"
294+
)
295+
296+
python path/to/tools/create-silk-asset-group.py "${create_args[@]:?}"
297+
```
278298

279299
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:
280300

@@ -283,7 +303,7 @@ For Snyk, configure and build the CXX Driver with `BSONCXX_POLY_USE_MNMLSTC=ON`
283303
. ~/.secrets/snyk-creds.txt
284304

285305
# Name of the new minor release branch. Ensure this is correct!
286-
branch="rX.Y"
306+
branch="releases/vX.Y"
287307

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

0 commit comments

Comments
 (0)