Skip to content

Commit

Permalink
Update for 1.11.0 release (#874)
Browse files Browse the repository at this point in the history
* remove duplicate step

The "Copy the organization ID" step is duplicated below in the "Update Snyk" section where it is needed.

* remove duplicate code snippet

It is an exact copy of the step above.

* fix referred location of installation instructions

* fix path to `ssdlc_compliance_report.md`

* update CHANGELOG and README for 1.11.0 release
  • Loading branch information
kevinAlbs authored Aug 2, 2024
1 parent 721e074 commit d09b342
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 22 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# ChangeLog
## (Next)
## 1.11.0
### New features
- Support `range` algorithm as stable.
### Deprecated
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ See [releasing](./doc/releasing.md).
Distribution packages (i.e., .deb/.rpm) are built and published for several Linux distributions. The installation of these packages for supported platforms is documented here.

### Unstable Development Distribution Packages ###
To install the latest unstable development package, change `1.10` to `development` in the package URLs listed in the subsequent instructions. For example, `https://libmongocrypt.s3.amazonaws.com/apt/ubuntu <release>/libmongocrypt/1.10` in the instructions would become `https://libmongocrypt.s3.amazonaws.com/apt/ubuntu <release>/libmongocrypt/development`. Do not use the unstable version of libmongocrypt in a production environment.
To install the latest unstable development package, change `1.11` to `development` in the package URLs listed in the subsequent instructions. For example, `https://libmongocrypt.s3.amazonaws.com/apt/ubuntu <release>/libmongocrypt/1.11` in the instructions would become `https://libmongocrypt.s3.amazonaws.com/apt/ubuntu <release>/libmongocrypt/development`. Do not use the unstable version of libmongocrypt in a production environment.

### .deb Packages (Debian and Ubuntu) ###

Expand All @@ -125,13 +125,13 @@ sudo sh -c 'curl -s --location https://pgp.mongodb.com/libmongocrypt.asc | gpg -
Second, create a list entry for the repository. For Ubuntu systems (be sure to change `<release>` to `xenial`, `bionic`, `focal`, or `jammy`, as appropriate to your system):

```
echo "deb https://libmongocrypt.s3.amazonaws.com/apt/ubuntu <release>/libmongocrypt/1.10 universe" | sudo tee /etc/apt/sources.list.d/libmongocrypt.list
echo "deb https://libmongocrypt.s3.amazonaws.com/apt/ubuntu <release>/libmongocrypt/1.11 universe" | sudo tee /etc/apt/sources.list.d/libmongocrypt.list
```

For Debian systems (be sure to change `<release>` to `stretch`, `buster`, `bullseye`, or `bookworm` as appropriate to your system):

```
echo "deb https://libmongocrypt.s3.amazonaws.com/apt/debian <release>/libmongocrypt/1.10 main" | sudo tee /etc/apt/sources.list.d/libmongocrypt.list
echo "deb https://libmongocrypt.s3.amazonaws.com/apt/debian <release>/libmongocrypt/1.11 main" | sudo tee /etc/apt/sources.list.d/libmongocrypt.list
```

Third, update the package cache:
Expand All @@ -156,7 +156,7 @@ Create the file `/etc/yum.repos.d/libmongocrypt.repo` with contents:
```
[libmongocrypt]
name=libmongocrypt repository
baseurl=https://libmongocrypt.s3.amazonaws.com/yum/redhat/$releasever/libmongocrypt/1.10/x86_64
baseurl=https://libmongocrypt.s3.amazonaws.com/yum/redhat/$releasever/libmongocrypt/1.11/x86_64
gpgcheck=1
enabled=1
gpgkey=https://pgp.mongodb.com/libmongocrypt.asc
Expand All @@ -175,7 +175,7 @@ Create the file `/etc/yum.repos.d/libmongocrypt.repo` with contents:
```
[libmongocrypt]
name=libmongocrypt repository
baseurl=https://libmongocrypt.s3.amazonaws.com/yum/amazon/2023/libmongocrypt/1.10/x86_64
baseurl=https://libmongocrypt.s3.amazonaws.com/yum/amazon/2023/libmongocrypt/1.11/x86_64
gpgcheck=1
enabled=1
gpgkey=https://pgp.mongodb.com/libmongocrypt.asc
Expand All @@ -194,7 +194,7 @@ Create the file `/etc/yum.repos.d/libmongocrypt.repo` with contents:
```
[libmongocrypt]
name=libmongocrypt repository
baseurl=https://libmongocrypt.s3.amazonaws.com/yum/amazon/2/libmongocrypt/1.10/x86_64
baseurl=https://libmongocrypt.s3.amazonaws.com/yum/amazon/2/libmongocrypt/1.11/x86_64
gpgcheck=1
enabled=1
gpgkey=https://pgp.mongodb.com/libmongocrypt.asc
Expand All @@ -213,7 +213,7 @@ Create the file `/etc/yum.repos.d/libmongocrypt.repo` with contents:
```
[libmongocrypt]
name=libmongocrypt repository
baseurl=https://libmongocrypt.s3.amazonaws.com/yum/amazon/2013.03/libmongocrypt/1.10/x86_64
baseurl=https://libmongocrypt.s3.amazonaws.com/yum/amazon/2013.03/libmongocrypt/1.11/x86_64
gpgcheck=1
enabled=1
gpgkey=https://pgp.mongodb.com/libmongocrypt.asc
Expand All @@ -236,7 +236,7 @@ sudo rpm --import https://pgp.mongodb.com/libmongocrypt.asc
Second, add the repository (be sure to change `<release>` to `12` or `15`, as appropriate to your system):

```
sudo zypper addrepo --gpgcheck "https://libmongocrypt.s3.amazonaws.com/zypper/suse/<release>/libmongocrypt/1.10/x86_64" libmongocrypt
sudo zypper addrepo --gpgcheck "https://libmongocrypt.s3.amazonaws.com/zypper/suse/<release>/libmongocrypt/1.11/x86_64" libmongocrypt
```

Finally, install the libmongocrypt packages:
Expand Down
15 changes: 2 additions & 13 deletions doc/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@ Go to [Snyk](https://app.snyk.io/) and select the `dev-prod` organization. If ac

![Reference Targets](img/reference-targets.png)

Copy the organization ID from [Snyk settings](https://app.snyk.io/org/dev-prod/manage/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.
Expand All @@ -44,15 +42,6 @@ snyk monitor \
--remote-repo-url=https://github.com/mongodb/libmongocrypt.git
```

```bash
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
Expand Down Expand Up @@ -80,7 +69,7 @@ Do the following when releasing:
- 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 Linux distribution package installation instructions in [README.md](../README.md) to refer to the new version `x.y`.
- Update the [libmongocrypt-release](https://spruce.mongodb.com/project/libmongocrypt-release/settings/general) 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>`.
Expand All @@ -106,7 +95,7 @@ Do the following when releasing:
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](https://wiki.corp.mongodb.com/display/DRIVERS/Using+AWS+Secrets+Manager+to+Store+Testing+Secrets) under `drivers/libmongocrypt`.
- Attach `etc/third_party_vulnerabilities.md` to the release.
- Attach `ssdlc_compliance_report.md` to the release.
- Attach `etc/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](https://www.mongodb.com/docs/manual/core/csfle/reference/libmongocrypt/). ([Example](https://jira.mongodb.org/browse/DOCSP-36863))
Expand Down

0 comments on commit d09b342

Please sign in to comment.