Skip to content

Commit b396b04

Browse files
authored
docs(maintainers): update release steps with recent examples (#2442)
1 parent 533acb2 commit b396b04

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

.github/maintainers_guide.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -79,19 +79,21 @@ Releasing can feel intimidating at first, but rest assured: if you make a mistak
7979

8080
- Generate the reference docs for that package by running `npm run docs`.
8181

82-
- Make a single commit for the version(s) bump, following the format in: ([Example](https://github.com/slackapi/node-slack-sdk/commit/1503609d79abf035e9e21bad7360e124e4211594))
82+
- Make a single commit for the version(s) bump, following the format in: ([Example](https://github.com/slackapi/node-slack-sdk/commit/ff03f7812c678bdc5cea5eace75db34631a88dda))
8383

84-
- Create a pull request for the version change ([Example](https://github.com/slackapi/node-slack-sdk/pull/1059))
84+
- Create a pull request for the version change ([Example](https://github.com/slackapi/node-slack-sdk/pull/2402))
8585

86-
- Add appropriate labels on the PR, including `release`
86+
- Add appropriate labels on the PR, including `release`, `pkg:*`, and `semver:*`
87+
88+
- Add appropriate milestone on the PR
8789

8890
6. Once the PR has been approved and tests have passed, merge it into the main repository.
8991

9092
- Check out your local `main` branch and update it to get the latest changes: `git checkout main && git pull origin main`
9193

9294
- Add a version tag (ie, `git tag @slack/[email protected]`)
9395

94-
- Push the new tag up to origin: `git push --tags origin`
96+
- Push the new tag up to origin: `git push origin @slack/[email protected]`
9597

9698
7. Publish the release to npm
9799
- To publish, you need to be a member of the `slack Org` on npm and set up 2-Factor Auth with your password generator of choice. Before you can publish with npm, you must run `npm login` from the command line.
@@ -100,23 +102,23 @@ Releasing can feel intimidating at first, but rest assured: if you make a mistak
100102

101103
- Run `npm publish . --otp YOUR_OTP_CODE`. To generate an OTP (One Time Password), use your password generator of choice (Duo, 1Password)
102104

103-
8. Close GitHub Milestone(s)
105+
8. Close GitHub Milestone
104106

105-
- Close the relevant GitHub Milestone(s) for the release(s)
107+
- Close the relevant GitHub Milestone for the release
106108

107109
- Check the existing GitHub Milestones to see if the next minor version exists. If it doesn't, then create a GitHub Milestone for new issues to live in. Typically, you'll create a new minor version - however, if there are any bugs that need to be carried over from the current GitHub Milestone, you could make a Milestone for a patch version to reflect those issues
108110

109111
- Move any unfinished, open issues to the next GitHub Milestone
110112

111-
9. Create GitHub Release(s) with release notes
113+
9. Create GitHub Release with release notes
112114

113-
- From the repository, navigate to the **Releases** section and draft a new release
115+
- From the repository, navigate to the **Releases** section and select [Draft a new release](https://github.com/slackapi/node-slack-sdk/releases/new)
114116

115117
- When creating the release notes, select the tag you generated earlier for your release and title the release the same name as the tag
116118

117119
- To see a list of changes between the last tag for the specific package, you can use this `git` command: `git log --oneline --full-history @slack/[email protected]..@slack/[email protected] -- packages/types`. Sub in the correct tags and the last argument should be the path to the sub-package you are releasing (in order to filter commits just to the specific path).
118120

119-
- Release notes should mention contributors, issues and PRs ([Example](https://github.com/slackapi/node-slack-sdk/releases/tag/%40slack%2Fweb-api%406.2.0))
121+
- Release notes should mention contributors, issues, PRs, milestone, and link to npm package ([Example](https://github.com/slackapi/node-slack-sdk/releases/tag/%40slack%2Ftypes%402.17.0))
120122

121123
- Once the release notes are ready, click the "Publish Release" button to make them public
122124

0 commit comments

Comments
 (0)