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
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -70,8 +70,8 @@ Releasing can feel intimidating at first, but rest assured: if you make a mistak
70
70
71
71
- Push the new tag up to origin: `git push --tags origin`
72
72
73
-
8. Publish the release to npm
74
-
- To publish, you need to be a member of the `slack Org` on npm and set up 2-Factor Auth with your passsword generator of choice. Before you can publish with npm, you must run `npm login` from the command line.
73
+
7. Publish the release to npm
74
+
- 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.
75
75
76
76
- As the final validation, within the package directory (ex: `packages/types`), run `mv package-lock.json package-lock.json.bk && rm -rf node_modules/ dist/ && npm i && npm test && npm pack` and confirm if there are `*.js`, `*.d.ts` files under the `dist` directory.
77
77
@@ -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/[email protected]` 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 Platfrom CLI](https://tools.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/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).
| Web API | Send data to or query data from Slack using any of [over 220 methods](https://docs.slack.dev/reference/methods). |[`@slack/web-api`](https://tools.slack.dev/node-slack-sdk/web-api)|
25
-
| OAuth | Set up the authentication flow using V2 OAuth for Slack apps as well as V1 OAuth for classic Slack apps. |[`@slack/oauth`](https://tools.slack.dev/node-slack-sdk/oauth)|
26
-
| Incoming Webhooks | Send notifications to a single channel which the user picks on installation. |[`@slack/webhook`](https://tools.slack.dev/node-slack-sdk/webhook)|
27
-
| Socket Mode | Listen for incoming messages and a limited set of events happening in Slack, using WebSocket. |[`@slack/socket-mode`](https://tools.slack.dev/node-slack-sdk/socket-mode)|
24
+
| Web API | Send data to or query data from Slack using any of [over 220 methods](https://docs.slack.dev/reference/methods). |[`@slack/web-api`](https://docs.slack.dev/node-slack-sdk/web-api)|
25
+
| OAuth | Set up the authentication flow using V2 OAuth for Slack apps as well as V1 OAuth for classic Slack apps. |[`@slack/oauth`](https://docs.slack.dev/node-slack-sdk/oauth)|
26
+
| Incoming Webhooks | Send notifications to a single channel which the user picks on installation. |[`@slack/webhook`](https://docs.slack.dev/node-slack-sdk/webhook)|
27
+
| Socket Mode | Listen for incoming messages and a limited set of events happening in Slack, using WebSocket. |[`@slack/socket-mode`](https://docs.slack.dev/node-slack-sdk/socket-mode)|
28
28
29
29
**Not sure about which APIs are right for your app?** Read our [blog
30
30
post](https://medium.com/slack-developer-blog/getting-started-with-slacks-apis-f930c73fc889) that explains the options.
@@ -34,7 +34,7 @@ If you're still not sure, [reach out for help](#getting-help) and our community
34
34
35
35
`@slack/events-api` and `@slack/interactive-messages` officially reached EOL on May 31st, 2021. Development has fully stopped for these packages and all remaining open issues and pull requests have been closed.
36
36
37
-
At this time, we recommend migrating to [Bolt for JavaScript](https://github.com/slackapi/bolt-js), a framework that offers all of the functionality available in those packages (and more). To help with that process, we've provided some [migration samples](https://tools.slack.dev/node-slack-sdk/tutorials/migrating-to-v6) for those looking to convert their existing apps.
37
+
At this time, we recommend migrating to [Bolt for JavaScript](https://github.com/slackapi/bolt-js), a framework that offers all of the functionality available in those packages (and more). To help with that process, we've provided some [migration samples](https://docs.slack.dev/node-slack-sdk/migration/migrating-to-v6) for those looking to convert their existing apps.
The following examples summarize the most common ways to use this package. There's also a [Getting Started
53
-
tutorial](https://tools.slack.dev/node-slack-sdk/getting-started) that's perfect for just starting out, and each
53
+
tutorial](https://docs.slack.dev/node-slack-sdk/getting-started) that's perfect for just starting out, and each
54
54
package's documentation, linked in the table above.
55
55
56
56
### Posting a message with Web API
@@ -88,15 +88,15 @@ where you can prototype your message's look and feel.
88
88
89
89
### Listening for an event with the Events API
90
90
91
-
Refer to [Bolt for JavaScript document pages](https://tools.slack.dev/bolt-js/concepts#event-listening).
91
+
Refer to [Bolt for JavaScript document pages](https://docs.slack.dev/bolt-js/concepts#event-listening).
92
92
93
93
### Responding to interactive messages
94
94
95
-
Refer to [Bolt for JavaScript document pages](https://tools.slack.dev/bolt-js/concepts#action-listening).
95
+
Refer to [Bolt for JavaScript document pages](https://docs.slack.dev/bolt-js/concepts#action-listening).
96
96
97
97
### Using Socket Mode
98
98
99
-
Refer to [the module document page](https://tools.slack.dev/node-slack-sdk/socket-mode) and [Bolt for JavaScript document page](https://tools.slack.dev/bolt-js/concepts#socket-mode).
99
+
Refer to [the module document page](https://docs.slack.dev/node-slack-sdk/socket-mode) and [Bolt for JavaScript document page](https://docs.slack.dev/bolt-js/concepts#socket-mode).
0 commit comments