From 5fa003651df8d19f206d11962f708bd243c62c3c Mon Sep 17 00:00:00 2001 From: Durran Jordan Date: Thu, 27 Jun 2024 18:37:27 +0200 Subject: [PATCH] docs(NODE-6238): update release integrity section --- readme.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/readme.md b/readme.md index fc7c1e4..495e75b 100644 --- a/readme.md +++ b/readme.md @@ -65,6 +65,12 @@ npm install mongodb-legacy ### Release Integrity +Releases are created automatically and signed using the [Node team's GPG key](https://pgp.mongodb.com/node-driver.asc). This applies to the git tag as well as all release packages provided as part of a GitHub release. To verify the provided packages, download the key and import it using gpg: + +``` +gpg --import node-driver.asc +``` + The GitHub release contains a detached signature file for the NPM package (named `mongodb-legacy-X.Y.Z.tgz.sig`). @@ -78,6 +84,10 @@ Using the result of the above command, a `curl` command can return the official To verify the integrity of the downloaded package, run the following command: ```shell gpg --verify mongodb-legacy-X.Y.Z.tgz.sig mongodb-legacy-X.Y.Z.tgz + +>[!Note] +No verification is done when using npm to install the package. To ensure release integrity when using npm, download the tarball manually from the GitHub release, verify the signature, then install the package from the downloaded tarball using `npm install mongodb-legacy-X.Y.Z.tgz`. + ``` ### Versioning