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
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,17 +52,17 @@ Releasing can feel intimidating at first, but rest assured: if you make a mistak
52
52
53
53
4. For each package to be released, run `npm run test` to verify that tests are passing and code is free of linting errors.
54
54
55
-
5.Generate the reference docs for that package by running `npm run docs`.
55
+
5.On our new branch, bump the version(s) in `package.json` (see [Versioning and Tags](https://github.com/slackapi/node-slack-sdk/blob/main/.github/maintainers_guide.md#-versioning-and-tags))
56
56
57
-
6. On your new branch, bump the version(s) in `package.json` (see [Versioning and Tags](https://github.com/slackapi/node-slack-sdk/blob/main/.github/maintainers_guide.md#-versioning-and-tags))
57
+
- Generate the reference docs for that package by running `npm run docs`.
58
58
59
59
- Make a single commit for the version(s) bump, following the format in: ([Example](https://github.com/slackapi/node-slack-sdk/commit/1503609d79abf035e9e21bad7360e124e4211594))
60
60
61
61
- Create a pull request for the version change ([Example](https://github.com/slackapi/node-slack-sdk/pull/1059))
62
62
63
63
- Add appropriate labels on the PR, including `release`
64
64
65
-
7. Once the PR has been approved and tests have passed, merge it into the main repository.
65
+
6. Once the PR has been approved and tests have passed, merge it into the main repository.
66
66
67
67
- Check out your local `main` branch and update it to get the latest changes: `git checkout main && git pull origin main`
68
68
@@ -77,15 +77,15 @@ Releasing can feel intimidating at first, but rest assured: if you make a mistak
77
77
78
78
- Run `npm publish . --otp YOUR_OTP_CODE`. To generate an OTP (One Time Password), use your password generator of choice (Duo, 1Password)
79
79
80
-
9. Close GitHub Milestone(s)
80
+
8. Close GitHub Milestone(s)
81
81
82
82
- Close the relevant GitHub Milestone(s) for the release(s)
83
83
84
84
- 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
85
85
86
86
- Move any unfinished, open issues to the next GitHub Milestone
87
87
88
-
10. Create GitHub Release(s) with release notes
88
+
9. Create GitHub Release(s) with release notes
89
89
90
90
- From the repository, navigate to the **Releases** section and draft a new release
91
91
@@ -97,7 +97,7 @@ Releasing can feel intimidating at first, but rest assured: if you make a mistak
97
97
98
98
- Once the release notes are ready, click the "Publish Release" button to make them public
99
99
100
-
11. Communicate the release (as appropriate)
100
+
10. Communicate the release (as appropriate)
101
101
102
102
-**Internal**
103
103
@@ -138,19 +138,19 @@ Releasing can feel intimidating at first, but rest assured: if you make a mistak
138
138
139
139
- Push the new tag up to origin: `git push --tags origin`
140
140
141
-
5. Publish the release to npm
141
+
6. Publish the release to npm
142
142
143
143
- Run `npm publish --tag <dist-tag> . --otp YOUR_OTP_CODE`
144
144
145
145
-`<dist-tag>` should be a label representative of the beta release. It could be feature-specific (i.e. `feat-token-rotation`) or it can be a generic release candidate (i.e. `2.5.0rc`). Whatever you decide: it must _not_ be `latest`, as that is reserved for non-beta releases.
146
146
147
147
- To generate an OTP (One Time Password), use your password generator of choice (Duo, 1Password)
148
148
149
-
6. Test that the publish was successful
149
+
7. Test that the publish was successful
150
150
151
151
- Run `npm info <PACKAGE_NAME> dist-tags`
152
152
153
-
7. Create GitHub Release(s) with release notes
153
+
8. Create GitHub Release(s) with release notes
154
154
155
155
- From the repository, navigate to the **Releases** section and draft a new release
156
156
@@ -163,7 +163,7 @@ Releasing can feel intimidating at first, but rest assured: if you make a mistak
163
163
### 🔖 Versioning and Tags
164
164
This project is versioned using [Semantic Versioning](http://semver.org/), particularly in the [npm flavor](https://docs.npmjs.com/getting-started/semantic-versioning). Each release is tagged using git. The naming convention for tags is `{package_name}@{version}`. For example, the tag `@slack/web-api@v5.0.0` marks the v5.0.0 release of the `@slack/web-api` package. A single commit will have multiple tags when multiple packages are released simultaneously.
165
165
166
-
One package that expands upon the standard major.minor.patch version schema typically associated with Semantic Versioning is the `@slack/cli-test` package. This package employs standard major.minor.patch version, in addition to a [build metadata suffix](https://semver.org/#spec-item-10) suffix of the form `+cli.X.Y.Z`, e.g. `0.1.0+cli.2.24.0`. The version after `+cli.` communicates compatibility between the `@slack/cli-test` package and the [Slack CLI](https://docs.slack.dev/slack-cli/) itself.
166
+
One package that expands upon the standard major.minor.patch version schema typically associated with Semantic Versioning is the `@slack/cli-test` package. This package employs standard major.minor.patch version, in addition to a [build metadata suffix](https://semver.org/#spec-item-10) suffix of the form `+cli.X.Y.Z`, e.g. `0.1.0+cli.2.24.0`. The version after `+cli.` communicates compatibility between the `@slack/cli-test` package and the [Slack CLI](https://docs.slack.dev/tools/slack-cli/) itself.
167
167
168
168
### 🪵 Branches
169
169
`main` is where active development occurs. Long running named feature branches are occasionally created for collaboration on a feature that has a large scope (because everyone cannot push commits to another person's open Pull Request). After a major version increment, a maintenance branch for the older major version is left open (e.g. `v3`, `v4`, etc).
0 commit comments