docs(maintainers): update release notes testing and publishing steps to be more clear #2512
Conversation
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2512 +/- ##
=======================================
Coverage 93.17% 93.17%
=======================================
Files 40 40
Lines 11384 11384
Branches 726 726
=======================================
Hits 10607 10607
Misses 765 765
Partials 12 12
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
zimeg
left a comment
zimeg
left a comment
There was a problem hiding this comment.
📬 Leaving a few notes for wonderful reviewers!
| 1. **Check GitHub Milestones**: Before merging the release PR please check the relevant [Milestones](https://github.com/slackapi/node-slack-sdk/milestones). If issues or pull requests are still open either decide to postpone the release or save those changes for a future update. | ||
|
|
||
| 2. **Review the release PR**: Verify that version bumps match expectations, `CHANGELOG` entries are clear, and CI checks pass. | ||
| 2. **Review the release PR**: Verify that version bumps match expectations, `CHANGELOG` entries are clear, and CI checks pass on the `main` branch. |
There was a problem hiding this comment.
🪵 note: Running tests on commits created from GitHub Actions IIRC requires additional scopes that only an app can access. We might follow up with a custom "release" bot but I'm uncertain if that's the best approach at the moment...
Here's a recent release for reference:
🔗 #2509
| 2. **Review the release PR**: Verify that version bumps match expectations, `CHANGELOG` entries are clear, and CI checks pass on the `main` branch. | ||
|
|
||
| 3. **Merge and approve**: Merge the release PR, then approve the publish workflow to release packages to npm. | ||
| 3. **Merge and approve**: Merge the release PR, then approve the [publish](https://github.com/slackapi/node-slack-sdk/actions/workflows/release.yml) workflow to release packages to npm. |
There was a problem hiding this comment.
🔏 note: This is required lest a pending workflow remain pending! Now we link to the page for approval.
mwbrooks
left a comment
mwbrooks
left a comment
There was a problem hiding this comment.
✅ Thanks for keeping out docs updated. Really good call out to approve the workflow - that can be easily overlooked by folks new to the release process.
| 2. **Review the release PR**: Verify that version bumps match expectations, `CHANGELOG` entries are clear, and CI checks pass on the `main` branch. | ||
|
|
||
| 3. **Merge and approve**: Merge the release PR, then approve the publish workflow to release packages to npm. | ||
| 3. **Merge and approve**: Merge the release PR, then approve the [publish](https://github.com/slackapi/node-slack-sdk/actions/workflows/release.yml) workflow to release packages to npm. |
2 participants
Summary
This PR updates the release notes for maintainers on testing and publishing steps for releases!
Requirements