chore: automate releases with pr

[mweberxyz]

This relates to...

#3042

Changes

Add two new github workflows: Create release PR, and Release.

Create release PR action is executed manually by a maintainer. It will take main, bump the version number as desired (either explicit, major, minor, or patch) and create a PR to be approved and merged.

Release action runs on all changes to main that change the package.json file.
If the version number has not changed, it immediately exits.
Otherwise, it publishes to NPM then creates a GitHub release.

Demo

In my fork I made three changes from the head commit:

1. changing the package.json name to a package which I control
2. Commenting out the undici-types publish steps
3. Remove npm provenance check.

Then,

Created a sample issue and PR

This PR made a non-version-bumping change to package.json to ensure the release workflow did not run.

PR: mweberxyz#16

See https://github.com/mweberxyz/nodejs-undici/actions/runs/8637094971 for the workflow run upon merge to main. Note the "release" step is skipped. The entire workflow would have been skipped had the package.json not been changed.

Ran the create PR workflow

Create PR workflow run: https://github.com/mweberxyz/nodejs-undici/actions/runs/8637108281

PR created automatically: mweberxyz#17

Merged the PR created by the create PR workflow

Workflow run upon merge to main: https://github.com/mweberxyz/nodejs-undici/actions/runs/8637133400

Which created the releases:

• https://www.npmjs.com/package/@mweberxyz/undici?activeTab=versions
• https://github.com/mweberxyz/nodejs-undici/releases/tag/v6.15.1

Checkboxes

• I have read and agreed to the Developer's Certificate of Origin
• Tested
• Review ready

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.03%. Comparing base (6481804) to head (ff027a9).
Report is 3 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3089      +/-   ##
==========================================
+ Coverage   94.00%   94.03%   +0.03%     
==========================================
  Files          89       89              
  Lines       24314    24357      +43     
==========================================
+ Hits        22856    22904      +48     
+ Misses       1458     1453       -5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[mweberxyz]

Little annoyance noticed: the release notes contain the release commit itself. I will strip those off.

[mcollina]

lgtm

[mcollina]

Little annoyance noticed: the release notes contain the release commit itself. I will strip those off.

Can you articulate?

[mweberxyz]

Little annoyance noticed: the release notes contain the release commit itself. I will strip those off.

Can you articulate?

If you take a look at the release notes for the test release:

The auto-generated release notes include all PRs, including the PR which bumped the version in package.json. It's not a show stopper, but seems a bit duplicative - would be preferred if that line wasn't there imo.

[mweberxyz]

@mcollina ptal at three additional commits

[mcollina]

lgtm