Skip to content

Latest commit

 

History

History
153 lines (125 loc) · 9.17 KB

releasing.md

File metadata and controls

153 lines (125 loc) · 9.17 KB
Raw

Releasing libmongocrypt

These steps describe releasing the libmongocrypt C library (not the language bindings).

Version number scheme

Version numbers of libmongocrypt must follow the format 1.[0-9].[0-9] for releases and 1.[0-9].[0-9]-(alpha|beta|rc)[0-9] for pre-releases. This ensures that Linux distribution packages built from each commit are published to the correct location.

Steps to release

Check for Vulnerabilities

Snyk and Silk are used to satisfy vulnerability scanning requirements of DRIVERS-714. Prior to releasing, ensure necessary reported vulnerabilities meet requirements described in: MongoDB Software Security Development Lifecycle Policy.

Check Snyk

Go to Snyk and select the dev-prod organization. If access is needed, see Snyk Onboarding. Check the CLI target named mongodb/libmongocrypt. The CLI targets may be identified by this icon: CLI icon. There are reference targets for each tracked branch:

Reference Targets

Copy the organization ID from Snyk settings.

Update Snyk

Update the Snyk reference target tracking the to-be-released branch. For a patch release (e.g. x.y.z), check-out the rx.y branch and update the rx.y reference target. For a minor release (e.g. x.y.0), check out the master branch update the master reference target.

Run cmake to ensure generated source files are present:

cmake -S. -Bcmake-build -D BUILD_TESTING=OFF
cmake --build cmake-build --target mongocrypt

Print dependencies found by Snyk and verify libbson is found:

snyk test --unmanaged --print-dep-paths

Copy the organization ID from Snyk settings. Create the new Snyk reference target to track the newly created release branch:

snyk auth
snyk monitor \
--org=$ORGANIZATION_ID \
--target-reference="<rx.y or master>" \
--unmanaged \
--remote-repo-url=https://github.com/mongodb/libmongocrypt.git
snyk auth
snyk monitor \
--org=$ORGANIZATION_ID \
--target-reference=<rx.y or master> \
--unmanaged \
--remote-repo-url=https://github.com/mongodb/libmongocrypt.git

Check the updated reference targets in Snyk for detected vulnerabilities.

Check Silk

Get credentials for Silk from the drivers/libmongocrypt vault in AWS Secrets Manager.

Download the Augmented SBOM using:

./.evergreen/earthly.sh \
   --secret silk_client_id=${silk_client_id} \
   --secret silk_client_secret=${silk_client_secret} \
   +sbom-download \
   --out cyclonedx.augmented.sbom.json \
   --branch <branch>

Check the contents of the "vulnerabilities" field (if present) in the Augmented SBOM.

Release

Do the following when releasing:

  • If this is a feature release (e.g. x.y.0 or x.0.0), follow these steps: Creating SSDLC static analysis reports.

  • Check out the release branch. For a release x.y.z, the release branch is rx.y. If this is a new minor release (x.y.0), create the release branch.

  • Update CHANGELOG.md with the version being released.

  • Ensure etc/purls.txt is up-to-date.

  • Update etc/third_party_vulnerabilities.md with any updates to new or known vulnerabilities for third party dependencies that must be reported.

  • If this is a new minor release (e.g. x.y.0):

    • Update the Linux distribution package installation instructions in the below sections to refer to the new version x.y.
    • Update the libmongocrypt-release Evergreen project (requires auth) to set Branch Name to rx.y.

  • Commit the changes on the rx.y branch with a message like "Update CHANGELOG.md for x.y.z".

  • Tag the commit with git tag -a <tag>.

    • Push both the branch ref and tag ref in the same command: git push origin master 1.8.0-alpha0 or git push origin r1.8 1.8.4
    • Pushing the branch ref and the tag ref in the same command eliminates the possibility of a race condition in Evergreen (for building resources based on the presence of a release tag)
    • Note that in the future (e.g., if we move to a PR-based workflow for releases, or if we simply want to take better advantage of advanced Evergreen features), it is possible to use Evergreen's "Trigger Versions With Git Tags" feature by updating both config.yml and the project's settings in Evergreen

  • Ensure the version on Evergreen with the tagged commit is scheduled. The following tasks must pass to complete the release:

    • upload-all
    • windows-upload-release
    • All publish-packages tasks.
      • If the publish-packages tasks fail with an error like [curator] 2024/01/02 13:56:17 [p=emergency]: problem submitting repobuilder job: 404 (Not Found), this suggests the published path does not yet exist. Barque (the Linux package publishing service) has protection to avoid unintentional publishes. File a DEVPROD ticket (example) and assign to the team called Release Infrastructure to request the path be created. Then re-run the failing publish-packages task. Ask in the slack channel #devprod-release-tools for further help with Barque or curator.

  • Create the release from the GitHub releases page from the new tag.

    • Attach the tarball and signature file from the Files tab of the windows-upload-release task. Example.
    • Attach the Augmented SBOM file. Download the Augmented SBOM using: 
      ./.evergreen/earthly.sh \
   --secret silk_client_id=${silk_client_id} \
   --secret silk_client_secret=${silk_client_secret} \
   +sbom-download \
   --out cyclonedx.augmented.sbom.json \
   --branch <branch>
      For a new minor release, use master for --branch. For a patch release, use the release branch (e.g. rx.y). Secrets can be obtained from AWS Secrets Manager under drivers/libmongocrypt.
    • Attach etc/third_party_vulnerabilities.md to the release.
    • Attach ssdlc_compliance_report.md to the release.

  • If this is a new minor release (e.g. x.y.0):

    • File a DOCSP ticket to update the installation instructions on Install libmongocrypt. (Example)

    • Create a new Silk asset group. Use the newly created release branch (e.g. rx.y) as the --branch argument:

      ./.evergreen/earthly.sh \
   --secret silk_client_id=${silk_client_id} \
   --secret silk_client_secret=${silk_client_secret} \
   +silk-create-asset-group \
   --branch <branch>

    • Create a new Snyk reference target. The following instructions use the example branch rx.y:

      Run cmake to ensure generated source files are present:

      cmake -S. -Bcmake-build -D BUILD_TESTING=OFF
cmake --build cmake-build --target mongocrypt

      Print dependencies found by Snyk and verify libbson is found:

      snyk test --unmanaged --print-dep-paths

      Copy the organization ID from Snyk settings. Create the new Snyk reference target to track the newly created release branch:

      snyk auth
snyk monitor \
 --org=$ORGANIZATION_ID \
 --target-reference=rx.y \
 --unmanaged \
 --remote-repo-url=https://github.com/mongodb/libmongocrypt.git

      Snyk reference targets for older release branches may be removed if no further releases are expected on the branch.

  • Make a PR to apply the "Update CHANGELOG.md for x.y.z" commit to the master branch.

  • Update the release on the Jira releases page.

  • Record the release on C/C++ Release Info. This is done to meet SSDLC reporting requirements.

  • Add a link to the Evergreen waterfall for the tagged commit to libmongocrypt Security Testing Summary.

Homebrew steps

Submit a PR to update the Homebrew package https://github.com/mongodb/homebrew-brew/blob/master/Formula/libmongocrypt.rb. (Example). If not on macOS, request a team member to do this step.

Debian steps

Refer to the Debian steps. If you are not a Debian maintainer on the team, request a team member to do this step.