Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: slackapi/node-slack-sdk
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: @slack/[email protected]
Choose a base ref
...
head repository: slackapi/node-slack-sdk
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: main
Choose a head ref

Commits on Aug 19, 2024

  1. Copy the full SHA
    d386133 View commit details

Commits on Aug 20, 2024

  1. Copy the full SHA
    deb51ea View commit details

Commits on Aug 21, 2024

  1. Copy the full SHA
    83a52fd View commit details
  2. cli-test(feat): expose timeout argument for activity tail and run sta…

    …rt/stop methods (#1897)
    Fil Maj authored Aug 21, 2024
    Copy the full SHA
    f3c4ac9 View commit details
  3. Publish @slack/cli-test@1.1.0 (#1898)

    Fil Maj authored Aug 21, 2024
    Copy the full SHA
    f37115b View commit details

Commits on Aug 23, 2024

  1. Copy the full SHA
    e5a4f3f View commit details

Commits on Aug 28, 2024

  1. Copy the full SHA
    f93054e View commit details
  2. Copy the full SHA
    be8cb4e View commit details

Commits on Aug 30, 2024

  1. Copy the full SHA
    d857511 View commit details
  2. Publish @slack/types@2.13.0 (#1908)

    Fil Maj authored Aug 30, 2024
    Copy the full SHA
    636e4d7 View commit details
  3. Copy the full SHA
    220da72 View commit details

Commits on Sep 3, 2024

  1. Copy the full SHA
    7bf89e6 View commit details
  2. Copy the full SHA
    8ba12a9 View commit details
  3. Copy the full SHA
    6012780 View commit details
  4. chore(deps): bump actions/stale from 4.0.0 to 9.0.0 (#1916)

    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Sep 3, 2024
    Copy the full SHA
    aa98f8b View commit details
  5. chore(deps-dev): bump @types/node from 20.16.3 to 22.5.2 in /packages…

    …/cli-hooks (#1917)
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Sep 3, 2024
    Copy the full SHA
    99a9b56 View commit details
  6. chore(deps-dev): bump eslint-plugin-jsdoc from 48.11.0 to 50.2.2 in /…

    …packages/cli-hooks (#1918)
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Sep 3, 2024
    Copy the full SHA
    7d7c2ae View commit details
  7. chore(deps-dev): bump c8 from 9.1.0 to 10.1.2 in /packages/cli-hooks (#…

    …1919)
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Sep 3, 2024
    Copy the full SHA
    83102d7 View commit details
  8. chore(deps-dev): bump typescript from 5.4.5 to 5.5.4 in /packages/cli…

    …-hooks (#1920)
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Sep 3, 2024
    Copy the full SHA
    a8ada42 View commit details
  9. chore(deps): bump the docusaurus group across 6 directories with 10 u…

    …pdates (#1922)
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Sep 3, 2024
    Copy the full SHA
    bff02dd View commit details
  10. chore(deps-dev): bump sinon from 17.0.2 to 18.0.0 in /packages/cli-ho…

    …oks (#1921)
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Sep 3, 2024
    Copy the full SHA
    892bebd View commit details
  11. chore(deps-dev): bump eslint from 8.57.0 to 9.9.1 (#1923)

    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Sep 3, 2024
    Copy the full SHA
    a27c10b View commit details
  12. chore(deps-dev): bump eslint-plugin-jsdoc from 46.10.1 to 50.2.2 (#1924)

    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Sep 3, 2024
    Copy the full SHA
    b1b7006 View commit details
  13. chore(deps-dev): bump docusaurus-plugin-typedoc from 1.0.4 to 1.0.5 i…

    …n /docs (#1925)
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Sep 3, 2024
    Copy the full SHA
    ef43033 View commit details
  14. chore(deps): bump prism-react-renderer from 2.3.1 to 2.4.0 in /docs (#…

    …1926)
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Sep 3, 2024
    Copy the full SHA
    f23b85c View commit details
  15. chore(deps-dev): bump eslint-plugin-jsdoc from 48.11.0 to 50.2.2 in /…

    …packages/cli-test (#1927)
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Sep 3, 2024
    Copy the full SHA
    6ade9b0 View commit details
  16. chore(deps-dev): bump @types/node from 18.19.48 to 22.5.2 in /package…

    …s/cli-test (#1928)
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Sep 3, 2024
    Copy the full SHA
    fe5c019 View commit details
  17. Copy the full SHA
    876f349 View commit details
  18. Copy the full SHA
    7907511 View commit details
  19. chore(deps-dev): bump typedoc-plugin-markdown from 4.2.3 to 4.2.6 in …

    …/docs (#1968)
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Sep 3, 2024
    Copy the full SHA
    0e5209c View commit details

Commits on Sep 4, 2024

  1. chore(deps-dev): bump typedoc from 0.26.5 to 0.26.6 in /docs

    Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.26.5 to 0.26.6.
    - [Release notes](https://github.com/TypeStrong/TypeDoc/releases)
    - [Changelog](https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md)
    - [Commits](TypeStrong/typedoc@v0.26.5...v0.26.6)
    
    ---
    updated-dependencies:
    - dependency-name: typedoc
      dependency-type: direct:development
      update-type: version-update:semver-patch
    ...
    
    Signed-off-by: dependabot[bot] <support@github.com>
    dependabot[bot] authored and seratch committed Sep 4, 2024
    Copy the full SHA
    f6c22bc View commit details
  2. chore(deps): bump dotenv in /examples/express-all-interactions

    Bumps [dotenv](https://github.com/motdotla/dotenv) from 5.0.1 to 16.4.5.
    - [Changelog](https://github.com/motdotla/dotenv/blob/master/CHANGELOG.md)
    - [Commits](motdotla/dotenv@v5.0.1...v16.4.5)
    
    ---
    updated-dependencies:
    - dependency-name: dotenv
      dependency-type: direct:production
      update-type: version-update:semver-major
    ...
    
    Signed-off-by: dependabot[bot] <support@github.com>
    dependabot[bot] authored and seratch committed Sep 4, 2024
    Copy the full SHA
    ed20a5b View commit details
  3. chore(deps): bump passport in /examples/greet-and-react

    Bumps [passport](https://github.com/jaredhanson/passport) from 0.6.0 to 0.7.0.
    - [Changelog](https://github.com/jaredhanson/passport/blob/master/CHANGELOG.md)
    - [Commits](jaredhanson/passport@v0.6.0...v0.7.0)
    
    ---
    updated-dependencies:
    - dependency-name: passport
      dependency-type: direct:production
      update-type: version-update:semver-minor
    ...
    
    Signed-off-by: dependabot[bot] <support@github.com>
    dependabot[bot] authored and seratch committed Sep 4, 2024
    Copy the full SHA
    bae0b12 View commit details
  4. chore(deps): bump dotenv in /examples/greet-and-react

    Bumps [dotenv](https://github.com/motdotla/dotenv) from 4.0.0 to 16.4.5.
    - [Changelog](https://github.com/motdotla/dotenv/blob/master/CHANGELOG.md)
    - [Commits](motdotla/dotenv@v4.0.0...v16.4.5)
    
    ---
    updated-dependencies:
    - dependency-name: dotenv
      dependency-type: direct:production
      update-type: version-update:semver-major
    ...
    
    Signed-off-by: dependabot[bot] <support@github.com>
    dependabot[bot] authored and seratch committed Sep 4, 2024
    Copy the full SHA
    5d0daef View commit details
  5. Copy the full SHA
    8faa273 View commit details
  6. Copy the full SHA
    c64af9a View commit details
  7. chore(deps-dev): bump c8 from 9.1.0 to 10.1.2 in /packages/socket-mode (

    #2000)
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Sep 4, 2024
    Copy the full SHA
    3d1e063 View commit details
  8. chore(deps-dev): bump c8 from 9.1.0 to 10.1.2 in /packages/oauth (#2001)

    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Sep 4, 2024
    Copy the full SHA
    34dd52e View commit details
  9. chore(deps-dev): bump c8 from 9.1.0 to 10.1.2 in /packages/web-api (#…

    …1998)
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Sep 4, 2024
    Copy the full SHA
    240b225 View commit details
  10. chore(deps-dev): bump c8 from 9.1.0 to 10.1.2 in /packages/cli-test (#…

    …1995)
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Sep 4, 2024
    Copy the full SHA
    3e96e40 View commit details
  11. chore(deps-dev): bump tsd from 0.30.7 to 0.31.1 in /packages/web-api (#…

    …2004)
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Sep 4, 2024
    Copy the full SHA
    9bc20a1 View commit details
  12. chore(deps-dev): bump sinon from 15.2.0 to 18.0.0 in /packages/logger…

    … in the dev-sinon group (#1979)
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Sep 4, 2024
    Copy the full SHA
    6de9c8d View commit details
  13. chore(deps-dev): bump sinon from 17.0.2 to 18.0.0 in /packages/socket…

    …-mode in the dev-sinon group (#1982)
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Sep 4, 2024
    Copy the full SHA
    466010c View commit details
  14. chore(deps-dev): bump typescript from 4.9.5 to 5.5.4 in /packages/log…

    …ger (#1997)
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Sep 4, 2024
    Copy the full SHA
    c894d08 View commit details
  15. chore(deps-dev): bump typescript from 5.0.4 to 5.5.4 in /packages/cli…

    …-test (#1999)
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Sep 4, 2024
    Copy the full SHA
    f1a796f View commit details
  16. chore(deps-dev): bump typescript from 5.3.3 to 5.5.4 in /packages/soc…

    …ket-mode (#2002)
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Sep 4, 2024
    Copy the full SHA
    1e83837 View commit details
  17. chore(deps-dev): bump typescript from 5.3.3 to 5.5.4 in /packages/oau…

    …th (#2003)
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Sep 4, 2024
    Copy the full SHA
    6641121 View commit details
  18. chore(deps-dev): bump typescript from 4.9.5 to 5.5.4 in /packages/typ…

    …es (#1984)
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Sep 4, 2024
    Copy the full SHA
    8b4ccbf View commit details
  19. chore(deps): bump node-localstorage from 1.3.1 to 3.0.5 in /examples/…

    …greet-and-react (#1985)
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Sep 4, 2024
    Copy the full SHA
    0374680 View commit details

Commits on Sep 5, 2024

  1. Copy the full SHA
    e1eeac9 View commit details
Showing 1,566 changed files with 38,411 additions and 98,780 deletions.
161 changes: 161 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
version: 2
updates:
- package-ecosystem: "npm"
directory: "/packages/cli-hooks"
groups:
dev-sinon:
dependency-type: "development"
patterns:
- "@types/sinon"
- "sinon"
dev-mocha:
dependency-type: "development"
patterns:
- "@types/mocha"
- "mocha"
schedule:
interval: "weekly"

- package-ecosystem: "npm"
directory: "/packages/cli-test"
groups:
dev-sinon:
dependency-type: "development"
patterns:
- "@types/sinon"
- "sinon"
dev-chai:
dependency-type: "development"
patterns:
- "@types/chai"
- "chai"
dev-mocha:
dependency-type: "development"
patterns:
- "@types/mocha"
- "mocha"
schedule:
interval: "weekly"

- package-ecosystem: "npm"
directory: "/packages/logger"
groups:
dev-sinon:
dependency-type: "development"
patterns:
- "@types/sinon"
- "sinon"
dev-chai:
dependency-type: "development"
patterns:
- "@types/chai"
- "chai"
dev-mocha:
dependency-type: "development"
patterns:
- "@types/mocha"
- "mocha"
schedule:
interval: "weekly"

- package-ecosystem: "npm"
directory: "/packages/oauth"
groups:
slack:
patterns:
- "@slack/*"
dev-sinon:
dependency-type: "development"
patterns:
- "@types/sinon"
- "sinon"
dev-chai:
dependency-type: "development"
patterns:
- "@types/chai"
- "chai"
dev-mocha:
dependency-type: "development"
patterns:
- "@types/mocha"
- "mocha"
schedule:
interval: "weekly"

- package-ecosystem: "npm"
directory: "/packages/socket-mode"
groups:
slack:
patterns:
- "@slack/*"
dev-sinon:
dependency-type: "development"
patterns:
- "@types/sinon"
- "sinon"
dev-chai:
dependency-type: "development"
patterns:
- "@types/chai"
- "chai"
dev-mocha:
dependency-type: "development"
patterns:
- "@types/mocha"
- "mocha"
schedule:
interval: "weekly"

- package-ecosystem: "npm"
directory: "/packages/types"
schedule:
interval: "weekly"

- package-ecosystem: "npm"
directories:
- "/packages/web-api"
- "/packages/web-api/test/integration-tests/**"
groups:
slack:
patterns:
- "@slack/*"
dev-sinon:
dependency-type: "development"
patterns:
- "@types/sinon"
- "sinon"
dev-chai:
dependency-type: "development"
patterns:
- "@types/chai"
- "chai"
dev-mocha:
dependency-type: "development"
patterns:
- "@types/mocha"
- "mocha"
schedule:
interval: "weekly"

- package-ecosystem: "npm"
directories:
- "/"
- "/docs"
- "/examples/*"
groups:
docusaurus:
patterns:
- "@docusaurus/*"
- "docusaurus-plugin-typedoc"
- "typedoc"
- "typedoc-plugin-markdown"
slack:
patterns:
- "@slack/*"
schedule:
interval: "monthly"

- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "monthly"
3 changes: 1 addition & 2 deletions .github/maintainers_guide.md
Original file line number Diff line number Diff line change
@@ -10,7 +10,7 @@ Maintaining this project requires installing [Node.js](https://nodejs.org). All
### ⚗️ Testing and Linting
The Node SDK is made up of multiple, individual packages, each with their own tests. As such, tests are run on a per-package basis. However, the top-level directory contains some development dependencies applicable to all packages. As a result, to run tests for any package, first ensure you run `npm install` from the top-level directory. Then, for a given package, navigate to the package's directory (ie, `packages/web-api`) and run `npm install` to install that package's required dependencies. Finally, run `npm test` to run that package's tests. To run just the linting and not the entire test suite, run `npm run lint`.

This project has tests for individual packages as `*.spec.js` files and inside of each's package's `src` directory. It also has integration tests in the `support/integration-tests` directory.
This project has tests for individual packages as `*.spec.js` files and inside of each's package's `src` directory. Also, for verifying the behavior with the real Slack server-side and developer experience with installed packages, you can run the tests amd 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.

@@ -24,7 +24,6 @@ Test code should be written in syntax that runs on the oldest supported Node.js

We have included `launch.json` files that store configuration for `vscode` debugging in each package. This allows you to set breakpoints in test files and interactively debug. Open the project in `vscode` and navigate to the debug screen on the left sidebar. The icon for it looks like a little lock bug with an x inside. At the top in `vscode`, select the configuration to run and press the green play icon to start debugging. Alternatively, on mac, you can press `cmd + shift + d` to get to the debug screen and `F5` to start debugging. If you are using `vscode` debugging, don't forget to lint the source (`npm run lint`) manually.

Also, for verifying the behavior with the real Slack server-side and developer experience with installed packages, you can run the tests amd 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.

### 📄 Managing Documentation

51 changes: 42 additions & 9 deletions .github/workflows/ci-build.yml
Original file line number Diff line number Diff line change
@@ -8,11 +8,11 @@ on:

jobs:
test:
runs-on: ubuntu-latest
timeout-minutes: 10
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest, windows-latest]
node-version: [18.x, 20.x, 22.x]
package:
- cli-hooks
@@ -24,36 +24,69 @@ jobs:
- types
- web-api
- webhook
runs-on: ${{ matrix.os }}
steps:
- name: Configure git settings (Windows)
if: matrix.os == 'windows-latest'
run: |
git config --global core.autocrlf false
git config --global core.eol lf
- uses: actions/checkout@v4
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
- run: npm --version
- name: Get Development Dependencies
run: npm i
- name: Build and Run Tests in Each Package
- run: npm install
working-directory: packages/${{ matrix.package }}
- name: Link dependent packages (*nix)
if: matrix.os == 'ubuntu-latest'
working-directory: packages/${{ matrix.package }}
run: |
npm install
# depending on which package we are testing, also npm link up other dependent packages
# depending on which package we are testing, also npm link up dependent packages within this monorepo
case "$PWD" in
*/webhook) pushd ../types && npm i && popd && npm link ../types;;
*/web-api) pushd ../types && npm i && popd && npm link ../types && pushd ../logger && npm i && popd && npm link ../logger;;
*/oauth) pushd ../logger && npm i && popd && npm link ../logger && pushd ../web-api && npm i && popd && npm link ../web-api;;
*/socket-mode) pushd ../logger && npm i && popd && npm link ../logger && pushd ../web-api && npm i && popd && npm link ../web-api;;
*) ;; # default
esac
npm test
- name: Link dependent packages (Windows)
if: matrix.os == 'windows-latest'
working-directory: packages/${{ matrix.package }}
run: |
# depending on which package we are testing, also npm link up dependent packages within this monorepo
# NOTE: the following is PowerShell
echo "$pwd"
switch -Wildcard ( "$pwd" )
{
'*\webhook'
{
pushd ..\types && npm i && popd && npm link ..\types
}
'*\web-api'
{
pushd ..\types && npm i && popd && npm link ..\types && pushd ..\logger && npm i && popd && npm link ..\logger
}
'*\oauth'
{
pushd ..\logger && npm i && popd && npm link ..\logger && pushd ..\web-api && npm i && popd && npm link ..\web-api
}
'*\socket-mode'
{
pushd ..\logger && npm i && popd && npm link ..\logger && pushd ..\web-api && npm i && popd && npm link ..\web-api
}
}
- run: npm test
working-directory: packages/${{ matrix.package }}
- name: Check for coverage report existence
id: check_coverage
uses: andstor/file-existence-action@v3
with:
files: packages/${{ matrix.package }}/coverage/lcov.info
- name: Upload code coverage
if: matrix.node-version == '22.x' && steps.check_coverage.outputs.files_exists == 'true'
uses: codecov/codecov-action@v4
if: matrix.node-version == '22.x' && matrix.os == 'ubuntu-latest' && steps.check_coverage.outputs.files_exists == 'true'
uses: codecov/codecov-action@v5
with:
token: ${{ secrets.CODECOV_TOKEN }}
directory: packages/${{ matrix.package }}/coverage
2 changes: 1 addition & 1 deletion .github/workflows/triage-issues.yml
Original file line number Diff line number Diff line change
@@ -17,7 +17,7 @@ jobs:
stale:
runs-on: ubuntu-latest
steps:
- uses: actions/stale@v4.0.0
- uses: actions/stale@v9.1.0
with:
days-before-issue-stale: 30
days-before-issue-close: 10
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -13,3 +13,4 @@ tmp/
*.bk

.DS_Store
.nyc_output/
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@ ___

## Getting Started

Visit the [documentation site](https://slack.dev/node-slack-sdk) for all the lovely details.
Visit the [documentation site](https://tools.slack.dev/node-slack-sdk) for all the lovely details.

_This SDK is a collection of single-purpose packages. The packages are aimed at making building Slack apps
easy, performant, secure, and scalable. They can help with just about anything in the Slack platform, from dropping
@@ -21,10 +21,10 @@ walk you through building your first Slack app using Node.js.

| Slack API | What its for | NPM Package |
|--------------|--------------|-------------------|
| Web API | Send data to or query data from Slack using any of [over 220 methods](https://api.slack.com/methods). | [`@slack/web-api`](https://slack.dev/node-slack-sdk/web-api) |
| OAuth | Setup the authentication flow using V2 OAuth for Slack apps as well as V1 OAuth for classic Slack apps. | [`@slack/oauth`](https://slack.dev/node-slack-sdk/oauth) |
| Incoming Webhooks | Send notifications to a single channel which the user picks on installation. | [`@slack/webhook`](https://slack.dev/node-slack-sdk/webhook) |
| Socket Mode | Listen for incoming messages and a limited set of events happening in Slack, using WebSocket. | [`@slack/socket-mode`](https://slack.dev/node-slack-sdk/socket-mode) |
| Web API | Send data to or query data from Slack using any of [over 220 methods](https://api.slack.com/methods). | [`@slack/web-api`](https://tools.slack.dev/node-slack-sdk/web-api) |
| OAuth | Setup 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) |
| Incoming Webhooks | Send notifications to a single channel which the user picks on installation. | [`@slack/webhook`](https://tools.slack.dev/node-slack-sdk/webhook) |
| 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) |

**Not sure about which APIs are right for your app?** Read our [blog
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

`@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.

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://slack.dev/node-slack-sdk/tutorials/migrating-to-v6) for those looking to convert their existing apps.
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.

## Installation

@@ -50,7 +50,7 @@ $ yarn add @slack/web-api @slack/socket-mode
## Usage

The following examples summarize the most common ways to use this package. There's also a [Getting Started
tutorial](https://slack.dev/node-slack-sdk/getting-started) that's perfect for just starting out, and each
tutorial](https://tools.slack.dev/node-slack-sdk/getting-started) that's perfect for just starting out, and each
package's documentation, linked in the table above.

### Posting a message with Web API
@@ -88,15 +88,15 @@ where you can prototype your message's look and feel.

### Listening for an event with the Events API

Refer to [Bolt for JavaScript document pages](https://slack.dev/bolt-js/concepts#event-listening).
Refer to [Bolt for JavaScript document pages](https://tools.slack.dev/bolt-js/concepts#event-listening).

### Responding to interactive messages

Refer to [Bolt for JavaScript document pages](https://slack.dev/bolt-js/concepts#action-listening).
Refer to [Bolt for JavaScript document pages](https://tools.slack.dev/bolt-js/concepts#action-listening).

### Using Socket Mode

Refer to [the module document page](https://slack.dev/node-slack-sdk/socket-mode) and [Bolt for JavaScript document page](https://slack.dev/bolt-js/concepts#socket-mode).
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).

## Requirements

32 changes: 32 additions & 0 deletions biome.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{
"$schema": "https://biomejs.dev/schemas/1.8.3/schema.json",
"formatter": {
"enabled": true,
"formatWithErrors": false,
"ignore": [],
"attributePosition": "auto",
"indentStyle": "space",
"indentWidth": 2,
"lineWidth": 120,
"lineEnding": "lf"
},
"javascript": {
"formatter": {
"quoteStyle": "single"
}
},
"linter": {
"enabled": true,
"rules": {
"recommended": true
}
},
"organizeImports": {
"enabled": true
},
"vcs": {
"enabled": true,
"clientKind": "git",
"useIgnoreFile": true
}
}
3 changes: 2 additions & 1 deletion docs/.gitignore
Original file line number Diff line number Diff line change
@@ -2,4 +2,5 @@ node_modules/
.docusaurus
.DS_Store
build/
.stylelintrc.json
.stylelintrc.json
content/reference
Loading