Skip to content

Commit 909b5bd

Browse files
github-actions[bot]zimeg
github-actions[bot]
and
zimeg
authored
chore: release (#2530)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Eden Zimbelman <[email protected]>
1 parent b8d922f commit 909b5bd

335 files changed

Lines changed: 4905 additions & 1543 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.changeset/chatty-tires-invite.md‎

Lines changed: 0 additions & 5 deletions
This file was deleted.

‎.changeset/grumpy-jobs-poke.md‎

Lines changed: 0 additions & 5 deletions
This file was deleted.

‎.changeset/plenty-times-rhyme.md‎

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎.changeset/vast-drinks-raise.md‎

Lines changed: 0 additions & 5 deletions
This file was deleted.

‎.github/maintainers_guide.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Maintaining this project requires installing [Node.js](https://nodejs.org). All
1111
### 🔧 Git hooks (optional)
1212

1313
#### Pre-commit lint hook
14+
1415
We provide an opt-in Git hook that runs `npm run lint` from the repository root before a commit is created.
1516

1617
Enable it once per clone:
@@ -26,6 +27,7 @@ git config --unset core.hooksPath
2627
```
2728

2829
Notes:
30+
2931
- The hook runs `npm run lint` from the repository root.
3032
- You can skip it with `git commit --no-verify` if needed.
3133

@@ -42,7 +44,6 @@ npm test --workspace packages/web-api
4244

4345
This project has tests for individual packages as `*.test.ts` (or `*.test.js`) files inside of each package's `src` directory. Tests use `node:test` as the test runner and `node:assert/strict` for assertions. Also, for verifying the behavior with the real Slack server-side and developer experience with installed packages, you can run the tests and scripts under `prod-server-integration-tests`. Refer to the README file in the directory for details. These tests are supposed to be run in the project maintainers' manual execution. They are not part of CI builds for now.
4446

45-
4647
Upon opening a PR, tests are executed by GitHub Actions, our continuous integration system. GitHub Actions runs several, more granular builds in order to report on success and failure in a more targeted way.
4748

4849
- There is one build for each package on each supported version of Node, as well as one for the integration tests on each supported version of Node.
@@ -115,7 +116,7 @@ New official package versions are published when the release PR created from cha
115116

116117
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.
117118

118-
2. **Review the release PR**: Verify that version bumps match expectations, `CHANGELOG` entries are clear, and CI checks pass on the `main` branch.
119+
2. **Review the release PR**: Verify that version bumps match expectations, `CHANGELOG` entries are clear, and CI checks pass on the `main` branch. Use `npm run docs` to generate documentation.
119120

120121
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.
121122

‎docs/english/reference/cli-test/classes/SlackCLIProcess.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ The CLI command to invoke
5454
### commandOptions
5555
5656
```ts
57-
commandOptions: undefined | SlackCLICommandOptions;
57+
commandOptions: SlackCLICommandOptions | undefined;
5858
```
5959
6060
Defined in: [cli/cli-process.ts:63](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/cli/cli-process.ts#L63)
@@ -68,7 +68,7 @@ The CLI command-specific options to pass to the command
6868
### globalOptions
6969
7070
```ts
71-
globalOptions: undefined | SlackCLIGlobalOptions;
71+
globalOptions: SlackCLIGlobalOptions | undefined;
7272
```
7373
7474
Defined in: [cli/cli-process.ts:58](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/cli/cli-process.ts#L58)

‎docs/english/reference/cli-test/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# @slack/cli-test v2.2.0+cli.2.32.2
1+
# @slack/cli-test v2.2.2
22

33
## Classes
44

‎docs/english/reference/cli-test/variables/SlackCLI.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Defined in: [cli/index.ts:22](https://github.com/slackapi/node-slack-sdk/blob/ma
1010

1111
Set of functions to spawn and interact with Slack Platform CLI processes and commands
1212

13-
## Type declaration
13+
## Type Declaration
1414

1515
### app
1616

‎docs/english/reference/cli-test/variables/SlackProduct.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ const SlackProduct: object;
88

99
Defined in: [utils/constants.ts:52](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/utils/constants.ts#L52)
1010

11-
## Type declaration
11+
## Type Declaration
1212

1313
### BUSINESS\_PLUS
1414

‎docs/english/reference/cli-test/variables/SlackTracerId.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Defined in: [utils/constants.ts:5](https://github.com/slackapi/node-slack-sdk/bl
1010

1111
This file should be kept up to date with the source of truth in the Slack CLI repo
1212

13-
## Type declaration
13+
## Type Declaration
1414

1515
### SLACK\_TRACE\_ADMIN\_APPROVAL\_REQUEST\_PENDING
1616

0 commit comments

Comments
 (0)