You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/maintainers_guide.md
+11-9Lines changed: 11 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -79,19 +79,21 @@ Releasing can feel intimidating at first, but rest assured: if you make a mistak
79
79
80
80
- Generate the reference docs for that package by running `npm run docs`.
81
81
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))
83
83
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))
85
85
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
87
89
88
90
6. Once the PR has been approved and tests have passed, merge it into the main repository.
89
91
90
92
- Check out your local `main` branch and update it to get the latest changes: `git checkout main && git pull origin main`
- 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]`
95
97
96
98
7. Publish the release to npm
97
99
- 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
100
102
101
103
- Run `npm publish . --otp YOUR_OTP_CODE`. To generate an OTP (One Time Password), use your password generator of choice (Duo, 1Password)
102
104
103
-
8. Close GitHub Milestone(s)
105
+
8. Close GitHub Milestone
104
106
105
-
- Close the relevant GitHub Milestone(s) for the release(s)
107
+
- Close the relevant GitHub Milestone for the release
106
108
107
109
- 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
108
110
109
111
- Move any unfinished, open issues to the next GitHub Milestone
110
112
111
-
9. Create GitHub Release(s) with release notes
113
+
9. Create GitHub Release with release notes
112
114
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)
114
116
115
117
- When creating the release notes, select the tag you generated earlier for your release and title the release the same name as the tag
116
118
117
119
- 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).
118
120
119
-
- Release notes should mention contributors, issuesand 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))
120
122
121
123
- Once the release notes are ready, click the "Publish Release" button to make them public
0 commit comments