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

Improve release_notes automation trigger

    • 3
    • 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 Node engineer
      I want to remove manual steps from the release process
      So that there is less opportunity to miss something

      User Impact

      • None

      Dependencies

      • None

      Unknowns

      • What trigger for release_notes is most desirable?
        • Ex. We can have a special comment on the release PR kick it off "/gen-notes". This is slightly nicer than going into the dispatch dialog, but there might be more to worry about, like having an allow list of users that the comment can come from
        • Ex. Every time HISTORY.md is modified is can run, a workflow that triggers a workflow requires a certain setup: see gh docs.
        • Ex. Re-generate the release notes whenever a PR lands in a release branch (4.x, 5.x, main, ect)

      Acceptance Criteria

      Implementation Requirements

      • Add an automated trigger to release notes that will run the steps to update the body of the release PR with the highlights from each relevant PR

      Testing Requirements

      • Manual verification that trigger works
      • Ensure manual workflow_dispatch method still works

      Documentation Requirements

      • Update release process document

      Follow Up Requirements

      • None

        There are no Sub-Tasks for this issue.

            Assignee:
            neal.beeken@mongodb.com Neal Beeken
            Reporter:
            neal.beeken@mongodb.com Neal Beeken
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: