Uploaded image for project: 'Node.js Driver'
  1. Node.js Driver
  2. NODE-5222

Use GitHub triggers for Node driver release

    • 5
    • 2
    • Not Needed
    • Not Needed
    • Hide

      1. What would you like to communicate to the user about this feature?
      2. Would you like the user to see examples of the syntax and/or executable code and its output?
      3. Which versions of the driver/connector does this apply to?

      Show
      1. What would you like to communicate to the user about this feature? 2. Would you like the user to see examples of the syntax and/or executable code and its output? 3. Which versions of the driver/connector does this apply to?

      Use Case

      As a... driver engineer
      I want... to automate the driver release via GitHub actions
      So that... it's easier to make the driver releases available to downstream teams and also take advantage of the npm package provenance

      User Impact

      • Shell will be able to have easily consumable nightly releases
      • Users will be able to ensure that they are using an authorized node driver package

      Dependencies

      • None

      Unknowns

      • Authentication steps required to configure GH automated release to npm

      Acceptance Criteria

      Implementation Requirements

      -Original:

      • Configure the necessary GitHub action to release the driver from an arbitrary branch with signing
        • Release version should be configurable, release notes should be configurable, release tags should be configurable (we don't want to apply latest tag to previous major)
      • Configure the necessary GitHub action to release the driver nightly builds from main with signing
        • Publish to npm as alpha with "nightly" tag-

      Updated:

      • System for nightly releases
        • Does not git tag, npm tag "nightly"
        • publishes as long as commit hash since the previous nightly has changed on main
      • System for alpha releases
        • Does not git tag, npm tag "alpha"
        • manual entry of version string
        • target branch to release from can be main or a WIP feature
      • System for typical releases
        • Bot keeps release PR up to date
        • Merging PR triggers automated publishing
        • Release notes can be gathered and generated from PR descriptions going out in release

      Testing Requirements

      • Confirm the alpha release works from any branch
      • Confirm the nightly release works from main
      • Confirm release notes generate properly

      Documentation Requirements

      • N/A

      Follow Up Requirements

      • File a follow up ticket to set up (or update) automated releases for our other repositories to use signing where possible
      • Inform shell that the nightly build is available

        There are no Sub-Tasks for this issue.

            Assignee:
            neal.beeken@mongodb.com Neal Beeken
            Reporter:
            daria.pardue@mongodb.com Daria Pardue
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: