Skip to content

chore: release #2530

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zimeg merged 4 commits into from
Mar 13, 2026
Merged

chore: release #2530

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f02df53
chore: release
github-actions[bot] Mar 12, 2026
9ea7240
docs: remove reverted change to logger package
zimeg Mar 13, 2026
a1af7a1
chore: docs autogen
zimeg Mar 13, 2026
86f937c
docs(maintainers): generate docs with releases
zimeg Mar 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
5 changes: 0 additions & 5 deletions .changeset/chatty-tires-invite.md
View file
Open in desktop

This file was deleted.

5 changes: 0 additions & 5 deletions .changeset/grumpy-jobs-poke.md
View file
Open in desktop

This file was deleted.

12 changes: 0 additions & 12 deletions .changeset/plenty-times-rhyme.md
View file
Open in desktop

This file was deleted.

5 changes: 0 additions & 5 deletions .changeset/vast-drinks-raise.md
View file
Open in desktop

This file was deleted.

5 changes: 3 additions & 2 deletions .github/maintainers_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Maintaining this project requires installing [Node.js](https://nodejs.org). All
### 🔧 Git hooks (optional)

#### Pre-commit lint hook

We provide an opt-in Git hook that runs `npm run lint` from the repository root before a commit is created.

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

Notes:

- The hook runs `npm run lint` from the repository root.
- You can skip it with `git commit --no-verify` if needed.

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

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.


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.

- 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.
Expand Down Expand Up @@ -115,7 +116,7 @@ New official package versions are published when the release PR created from cha

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.

2. **Review the release PR**: Verify that version bumps match expectations, `CHANGELOG` entries are clear, and CI checks pass on the `main` branch.
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.

Comment on lines -118 to 119
Copy link
Member

@zimeg zimeg Mar 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔭 note: We might have removed this step in prior changes and missed updates in recent releases. I'm adding this as a manual step for now but hope we can automate it - either per PR or within this release branch.

👾 ramble: I forget how changes are published, but if it's according to the main branch of this project we might prefer generating changes in the release PR?

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.

Expand Down
4 changes: 2 additions & 2 deletions docs/english/reference/cli-test/classes/SlackCLIProcess.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ The CLI command to invoke
### commandOptions
```ts
commandOptions: undefined | SlackCLICommandOptions;
commandOptions: SlackCLICommandOptions | undefined;
```
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)
Expand All @@ -68,7 +68,7 @@ The CLI command-specific options to pass to the command
### globalOptions
```ts
globalOptions: undefined | SlackCLIGlobalOptions;
globalOptions: SlackCLIGlobalOptions | undefined;
```
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)
Expand Down
2 changes: 1 addition & 1 deletion docs/english/reference/cli-test/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @slack/cli-test v2.2.0+cli.2.32.2
# @slack/cli-test v2.2.2

## Classes

Expand Down
2 changes: 1 addition & 1 deletion docs/english/reference/cli-test/variables/SlackCLI.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Defined in: [cli/index.ts:22](https://github.com/slackapi/node-slack-sdk/blob/ma

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

## Type declaration
## Type Declaration

### app

Expand Down
2 changes: 1 addition & 1 deletion docs/english/reference/cli-test/variables/SlackProduct.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ const SlackProduct: object;

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

## Type declaration
## Type Declaration

### BUSINESS\_PLUS

Expand Down
2 changes: 1 addition & 1 deletion docs/english/reference/cli-test/variables/SlackTracerId.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Defined in: [utils/constants.ts:5](https://github.com/slackapi/node-slack-sdk/bl

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

## Type declaration
## Type Declaration

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

Expand Down
4 changes: 2 additions & 2 deletions docs/english/reference/cli-test/variables/shell.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ const shell: object;

Defined in: [cli/shell.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/cli/shell.ts#L9)

## Type declaration
## Type Declaration

### assembleShellEnv()

Expand Down Expand Up @@ -122,7 +122,7 @@ Sleep function used to wait for cli to finish executing

#### Parameters

##### timeout
##### timeout?

`number` = `1000`

Expand Down
2 changes: 1 addition & 1 deletion docs/english/reference/logger/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @slack/logger v4.0.0
# @slack/logger v4.0.1

## Enumerations

Expand Down
6 changes: 3 additions & 3 deletions docs/english/reference/oauth/classes/AuthorizationError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ Error.stack
static stackTraceLimit: number;
```

Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:162
Copy link
Member

@zimeg zimeg Mar 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔍 note: The changes of #2532 share the @types/node package used for maintainers when generating documentation. I think this path is less confusing since it's common to have in development.

Defined in: node\_modules/@types/node/globals.d.ts:68

The `Error.stackTraceLimit` property specifies the number of stack frames
collected by a stack trace (whether generated by `new Error().stack` or
Expand All @@ -160,7 +160,7 @@ Error.stackTraceLimit
static captureStackTrace(targetObject, constructorOpt?): void;
```

Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:146
Defined in: node\_modules/@types/node/globals.d.ts:52

Creates a `.stack` property on `targetObject`, which when accessed returns
a string representing the location in the code at which
Expand Down Expand Up @@ -234,7 +234,7 @@ Error.captureStackTrace
static prepareStackTrace(err, stackTraces): any;
```

Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:150
Defined in: node\_modules/@types/node/globals.d.ts:56

#### Parameters

Expand Down
4 changes: 2 additions & 2 deletions docs/english/reference/oauth/classes/ClearStateStore.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ it can transfer the given InstallURLOptions value to the Redirect URL handler
### Constructor

```ts
new ClearStateStore(stateSecret, stateExpirationSeconds): ClearStateStore;
new ClearStateStore(stateSecret, stateExpirationSeconds?): ClearStateStore;
```

Defined in: [packages/oauth/src/state-stores/clear-state-store.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/clear-state-store.ts#L13)
Expand All @@ -29,7 +29,7 @@ Defined in: [packages/oauth/src/state-stores/clear-state-store.ts:13](https://gi

`string`

##### stateExpirationSeconds
##### stateExpirationSeconds?

`number` = `600`

Expand Down
4 changes: 2 additions & 2 deletions docs/english/reference/oauth/classes/FileInstallationStore.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ Defined in: [packages/oauth/src/installation-stores/file-store.ts:14](https://gi
### Constructor

```ts
new FileInstallationStore(__namedParameters): FileInstallationStore;
new FileInstallationStore(__namedParameters?): FileInstallationStore;
```

Defined in: [packages/oauth/src/installation-stores/file-store.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/file-store.ts#L19)

#### Parameters

##### \_\_namedParameters
##### \_\_namedParameters?

`FileInstallationOptions` = `{}`

Expand Down
6 changes: 3 additions & 3 deletions docs/english/reference/oauth/classes/GenerateInstallUrlError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ Error.stack
static stackTraceLimit: number;
```

Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:162
Defined in: node\_modules/@types/node/globals.d.ts:68

The `Error.stackTraceLimit` property specifies the number of stack frames
collected by a stack trace (whether generated by `new Error().stack` or
Expand All @@ -146,7 +146,7 @@ Error.stackTraceLimit
static captureStackTrace(targetObject, constructorOpt?): void;
```

Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:146
Defined in: node\_modules/@types/node/globals.d.ts:52

Creates a `.stack` property on `targetObject`, which when accessed returns
a string representing the location in the code at which
Expand Down Expand Up @@ -220,7 +220,7 @@ Error.captureStackTrace
static prepareStackTrace(err, stackTraces): any;
```

Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:150
Defined in: node\_modules/@types/node/globals.d.ts:56

#### Parameters

Expand Down
4 changes: 2 additions & 2 deletions docs/english/reference/oauth/classes/InstallProvider.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Fetches data from the installationStore
```ts
generateInstallUrl(
options,
stateVerification,
Copy link
Member

@zimeg zimeg Mar 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 note: This is an improvement to the docs dependencies it seems! This now reflects actual optional but default parameters:

node-slack-sdk/packages/oauth/src/install-provider.ts

Line 417 in b8d922f

stateVerification = true,

stateVerification?,
state?): Promise<string>;
```

Expand All @@ -90,7 +90,7 @@ Uses stateStore to generate a value for the state query param.

[`InstallURLOptions`](../interfaces/InstallURLOptions.md)

##### stateVerification
##### stateVerification?

`boolean` = `true`

Expand Down
6 changes: 3 additions & 3 deletions docs/english/reference/oauth/classes/InstallerInitializationError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ Error.stack
static stackTraceLimit: number;
```

Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:162
Defined in: node\_modules/@types/node/globals.d.ts:68

The `Error.stackTraceLimit` property specifies the number of stack frames
collected by a stack trace (whether generated by `new Error().stack` or
Expand All @@ -146,7 +146,7 @@ Error.stackTraceLimit
static captureStackTrace(targetObject, constructorOpt?): void;
```

Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:146
Defined in: node\_modules/@types/node/globals.d.ts:52

Creates a `.stack` property on `targetObject`, which when accessed returns
a string representing the location in the code at which
Expand Down Expand Up @@ -220,7 +220,7 @@ Error.captureStackTrace
static prepareStackTrace(err, stackTraces): any;
```

Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:150
Defined in: node\_modules/@types/node/globals.d.ts:56

#### Parameters

Expand Down
6 changes: 3 additions & 3 deletions docs/english/reference/oauth/classes/InvalidStateError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ Error.stack
static stackTraceLimit: number;
```

Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:162
Defined in: node\_modules/@types/node/globals.d.ts:68

The `Error.stackTraceLimit` property specifies the number of stack frames
collected by a stack trace (whether generated by `new Error().stack` or
Expand All @@ -146,7 +146,7 @@ Error.stackTraceLimit
static captureStackTrace(targetObject, constructorOpt?): void;
```

Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:146
Defined in: node\_modules/@types/node/globals.d.ts:52

Creates a `.stack` property on `targetObject`, which when accessed returns
a string representing the location in the code at which
Expand Down Expand Up @@ -220,7 +220,7 @@ Error.captureStackTrace
static prepareStackTrace(err, stackTraces): any;
```

Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:150
Defined in: node\_modules/@types/node/globals.d.ts:56

#### Parameters

Expand Down
6 changes: 3 additions & 3 deletions docs/english/reference/oauth/classes/MissingCodeError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ Error.stack
static stackTraceLimit: number;
```

Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:162
Defined in: node\_modules/@types/node/globals.d.ts:68

The `Error.stackTraceLimit` property specifies the number of stack frames
collected by a stack trace (whether generated by `new Error().stack` or
Expand All @@ -146,7 +146,7 @@ Error.stackTraceLimit
static captureStackTrace(targetObject, constructorOpt?): void;
```

Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:146
Defined in: node\_modules/@types/node/globals.d.ts:52

Creates a `.stack` property on `targetObject`, which when accessed returns
a string representing the location in the code at which
Expand Down Expand Up @@ -220,7 +220,7 @@ Error.captureStackTrace
static prepareStackTrace(err, stackTraces): any;
```

Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:150
Defined in: node\_modules/@types/node/globals.d.ts:56

#### Parameters

Expand Down
6 changes: 3 additions & 3 deletions docs/english/reference/oauth/classes/MissingStateError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ Error.stack
static stackTraceLimit: number;
```

Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:162
Defined in: node\_modules/@types/node/globals.d.ts:68

The `Error.stackTraceLimit` property specifies the number of stack frames
collected by a stack trace (whether generated by `new Error().stack` or
Expand All @@ -146,7 +146,7 @@ Error.stackTraceLimit
static captureStackTrace(targetObject, constructorOpt?): void;
```

Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:146
Defined in: node\_modules/@types/node/globals.d.ts:52

Creates a `.stack` property on `targetObject`, which when accessed returns
a string representing the location in the code at which
Expand Down Expand Up @@ -220,7 +220,7 @@ Error.captureStackTrace
static prepareStackTrace(err, stackTraces): any;
```

Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:150
Defined in: node\_modules/@types/node/globals.d.ts:56

#### Parameters

Expand Down
6 changes: 3 additions & 3 deletions docs/english/reference/oauth/classes/UnknownError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ Error.stack
static stackTraceLimit: number;
```

Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:162
Defined in: node\_modules/@types/node/globals.d.ts:68

The `Error.stackTraceLimit` property specifies the number of stack frames
collected by a stack trace (whether generated by `new Error().stack` or
Expand All @@ -146,7 +146,7 @@ Error.stackTraceLimit
static captureStackTrace(targetObject, constructorOpt?): void;
```

Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:146
Defined in: node\_modules/@types/node/globals.d.ts:52

Creates a `.stack` property on `targetObject`, which when accessed returns
a string representing the location in the code at which
Expand Down Expand Up @@ -220,7 +220,7 @@ Error.captureStackTrace
static prepareStackTrace(err, stackTraces): any;
```

Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:150
Defined in: node\_modules/@types/node/globals.d.ts:56

#### Parameters

Expand Down
Loading
Loading