Skip to content
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

feat(NODE-6157): add signature to github releases #4119

Merged
merged 9 commits into from
Jun 3, 2024

Conversation

aditi-khare-mongoDB
Copy link
Contributor

@aditi-khare-mongoDB aditi-khare-mongoDB commented May 23, 2024

Description

Sign releases in both 5.x and 6.x

What is changing?

Automate release signing with a detached signature and verification instructions in the README.
Link to an example of release signatures working with v2 (if you check the artifact link at the end of the compress_sign step, you can see the signature)

Is there new documentation needed for these changes?

No

What is the motivation for this change?

SSDLC Compliance

Release Highlight

Add Signature to Github Releases

The Github release for the mongodb package now contains a detached signature file for the NPM package (named
mongodb-X.Y.Z.tgz.sig), on every major and patch release to 6.x and 5.x. To verify the signature, follow the instructions in the 'Release Integrity' section of the README.md file.

Double check the following

  • Ran npm run check:lint script
  • Self-review completed using the steps outlined here
  • PR title follows the correct format: type(NODE-xxxx)[!]: description
    • Example: feat(NODE-1234)!: rewriting everything in coffeescript
  • Changes are covered by tests
  • New TODOs have a related JIRA ticket

@aditi-khare-mongoDB aditi-khare-mongoDB marked this pull request as ready for review May 23, 2024 21:48
@aditi-khare-mongoDB aditi-khare-mongoDB changed the title feat(NODE-5167): Sign Releases feat(NODE-6157): Sign Releases May 24, 2024
@W-A-James W-A-James self-assigned this May 24, 2024
@W-A-James W-A-James added the Primary Review In Review with primary reviewer, not yet ready for team's eyes label May 24, 2024
@aditi-khare-mongoDB aditi-khare-mongoDB changed the title feat(NODE-6157): Sign Releases feat(NODE-6157): Add Signature to Github Releases May 28, 2024
@aditi-khare-mongoDB aditi-khare-mongoDB changed the title feat(NODE-6157): Add Signature to Github Releases feat(NODE-6157): add signature to github releases May 28, 2024
W-A-James
W-A-James previously approved these changes May 29, 2024
@W-A-James W-A-James added Team Review Needs review from team Primary Review In Review with primary reviewer, not yet ready for team's eyes and removed Primary Review In Review with primary reviewer, not yet ready for team's eyes Team Review Needs review from team labels May 29, 2024
@W-A-James W-A-James dismissed their stale review May 29, 2024 19:27

outdated, pending other fixes

W-A-James
W-A-James previously approved these changes May 31, 2024
@W-A-James W-A-James added Team Review Needs review from team and removed Primary Review In Review with primary reviewer, not yet ready for team's eyes labels May 31, 2024
@baileympearson
Copy link
Contributor

Do we have an example of a successful signing using the gpg-sign v2 action? Either here or from js-bson would be fine since I assume the scripts are almost identical.

@aditi-khare-mongoDB
Copy link
Contributor Author

@baileympearson Just added a link to an example in the PR description!

@W-A-James W-A-James merged commit f38c5fe into main Jun 3, 2024
29 of 33 checks passed
@W-A-James W-A-James deleted the NODE-5167/sign-releases branch June 3, 2024 15:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team Review Needs review from team
Projects
None yet
4 participants