Skip to content

CXX-3008 Improve Silk/Snyk post-release instructions with explicit commands #1151

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 18, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions etc/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,24 @@ The new branch should be continuously tested on Evergreen. Update the "Display N

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

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.
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:

```bash
# Snyk credentials. Ask for these from a team member.
. ~/.secrets/silk-creds.txt.

create_args=(
--silk-client-id "${SILK_CLIENT_ID:?}"
--silk-client-secret "${SILK_CLIENT_SECRET:?}"
--project "mongo-cxx-driver"
--branch "releases/vX.Y" # Ensure correct branch name!
--asset-id "mongo-cxx-driver-X.Y" # Explicitly suffix the asset ID with the release version.
--code-repo-url "https://github.com/mongodb/mongo-cxx-driver"
--sbom-lite-path="etc/cyclonedx.sbom.json"
)

python path/to/tools/create-silk-asset-group.py "${create_args[@]:?}"
```

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:

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

# Name of the new minor release branch. Ensure this is correct!
branch="rX.Y"
branch="releases/vX.Y"

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