Merge branch 'main' of https://github.com/slackapi/node-slack-sdk into feat-work-objects

Author: vegeris

.github/contributing.md

@@ -24,9 +24,9 @@ There are many ways you can contribute! :heart:
 
 ### Tests :mag:, Documentation :books:, Miscellaneous :sparkles:
 -  If you'd like to improve the tests, you want to make the documentation clearer, you have an
-   alternative implementation of something that may have advantages over the way its currently
+   alternative implementation of something that may have advantages over the way it's currently
    done, or you have any other change, we would be happy to hear about it!
-  -  If its a trivial change, go ahead and [send a Pull Request](#creating_a_pull_request) with the changes you have in mind.
+  -  If it's a trivial change, go ahead and [send a Pull Request](#creating_a_pull_request) with the changes you have in mind.
   -  If not, [open an Issue](https://github.com/slackapi/node-slack-sdk/issues/new) to discuss the idea first.
 
 If you're new to our project and looking for some way to make your first contribution, look for

.github/dependabot.yml

@@ -13,6 +13,10 @@ updates:
         patterns:
           - "@types/mocha"
           - "mocha"
+    labels:
+      - "dependencies"
+      - "javascript"
+      - "pkg:cli-hooks"
     schedule:
       interval: "weekly"
 
@@ -34,6 +38,10 @@ updates:
         patterns:
           - "@types/mocha"
           - "mocha"
+    labels:
+      - "dependencies"
+      - "javascript"
+      - "pkg:cli-test"
     schedule:
       interval: "weekly"
 
@@ -55,6 +63,10 @@ updates:
         patterns:
           - "@types/mocha"
           - "mocha"
+    labels:
+      - "dependencies"
+      - "javascript"
+      - "pkg:logger"
     schedule:
       interval: "weekly"
 
@@ -79,6 +91,10 @@ updates:
         patterns:
           - "@types/mocha"
           - "mocha"
+    labels:
+      - "dependencies"
+      - "javascript"
+      - "pkg:oauth"
     schedule:
       interval: "weekly"
 
@@ -103,11 +119,19 @@ updates:
         patterns:
           - "@types/mocha"
           - "mocha"
+    labels:
+      - "dependencies"
+      - "javascript"
+      - "pkg:socket-mode"
     schedule:
       interval: "weekly"
 
   - package-ecosystem: "npm"
     directory: "/packages/types"
+    labels:
+      - "dependencies"
+      - "javascript"
+      - "pkg:types"
     schedule:
       interval: "weekly"
 
@@ -134,32 +158,51 @@ updates:
         patterns:
           - "@types/mocha"
           - "mocha"
+    labels:
+      - "dependencies"
+      - "javascript"
+      - "pkg:web-api"
+    schedule:
+      interval: "weekly"
+
+  - package-ecosystem: "npm"
+    directory: "/packages/webhook"
+    groups:
+      dev-chai:
+        dependency-type: "development"
+        patterns:
+          - "@types/chai"
+          - "chai"
+      dev-mocha:
+        dependency-type: "development"
+        patterns:
+          - "@types/mocha"
+          - "mocha"
+    labels:
+      - "dependencies"
+      - "javascript"
+      - "pkg:webhook"
     schedule:
       interval: "weekly"
 
   - package-ecosystem: "npm"
     directories:
-      - "/"
-      - "/docs"
       - "/examples/*"
     groups:
-      docusaurus:
-        patterns:
-          - "@docusaurus/*"
-          - "docusaurus-plugin-typedoc"
-          - "typedoc"
-          - "typedoc-plugin-markdown"
       slack:
         patterns:
           - "@slack/*"
-      react:
-        patterns:
-          - "react"
-          - "react-dom"
+    labels:
+      - "area:examples"
+      - "dependencies"
+      - "javascript"
     schedule:
       interval: "monthly"
 
   - package-ecosystem: "github-actions"
     directory: "/"
+    labels:
+      - "dependencies"
+      - "github_actions"
     schedule:
       interval: "monthly"

.github/maintainers_guide.md

@@ -29,7 +29,9 @@ We have included `launch.json` files that store configuration for `vscode` debug
 
 See the [Docs README](https://github.com/slackapi/node-slack-sdk/blob/main/docs/README.md) for information on how the docs site work. 
 
-The reference docs are generated on every site build, pulling from this repo's files. The site is built automatically on every release via `docs-deploy.yml`. 
+The reference docs for each package is independent of the others. They're generated using `typedoc` and `typedoc-plugin-markdown`. In each package's `package.json` there's a `docs` command that generates reference docs for that package based on the configuration settings found in `/package-name/typedoc.json`. 
+
+The script places the reference markdown files in `/reference/package-name`.
 
 ### 🚀 Releases
 _For beta releases, see [**Beta Releases**](https://github.com/slackapi/node-slack-sdk/blob/main/.github/maintainers_guide.md#-beta-releases) section below_
@@ -50,15 +52,17 @@ Releasing can feel intimidating at first, but rest assured: if you make a mistak
 
 4. For each package to be released, run `npm run test` to verify that tests are passing and code is free of linting errors.
 
-5. 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))
+5. Generate the reference docs for that package by running `npm run docs`.
+
+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))
 
     - Make a single commit for the version(s) bump, following the format in: ([Example](https://github.com/slackapi/node-slack-sdk/commit/1503609d79abf035e9e21bad7360e124e4211594))
 
     - Create a pull request for the version change ([Example](https://github.com/slackapi/node-slack-sdk/pull/1059))
 
     - Add appropriate labels on the PR, including `release`
 
-6. Once the PR has been approved and tests have passed, merge it into the main repository.
+7. Once the PR has been approved and tests have passed, merge it into the main repository.
 
     -  Check out your local `main` branch and update it to get the latest changes: `git checkout main && git pull origin main`
 
@@ -67,21 +71,21 @@ Releasing can feel intimidating at first, but rest assured: if you make a mistak
     -  Push the new tag up to origin: `git push --tags origin`
 
 7. Publish the release to npm
-    - 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.
+    - 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.
 
     - 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.
 
     - Run `npm publish . --otp YOUR_OTP_CODE`. To generate an OTP (One Time Password), use your password generator of choice (Duo, 1Password)
 
-8. Close GitHub Milestone(s)
+9. Close GitHub Milestone(s)
 
     - Close the relevant GitHub Milestone(s) for the release(s)
 
     - 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
 
     - Move any unfinished, open issues to the next GitHub Milestone
 
-9. Create GitHub Release(s) with release notes
+10. Create GitHub Release(s) with release notes
 
     - From the repository, navigate to the **Releases** section and draft a new release
 
@@ -93,7 +97,7 @@ Releasing can feel intimidating at first, but rest assured: if you make a mistak
 
     - Once the release notes are ready, click the "Publish Release" button to make them public
 
-10. Communicate the release (as appropriate)
+11. Communicate the release (as appropriate)
 
     - **Internal**
 
@@ -159,7 +163,7 @@ Releasing can feel intimidating at first, but rest assured: if you make a mistak
 ### 🔖 Versioning and Tags
 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.
 
-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://api.slack.com/automation/quickstart) itself.
+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.
 
 ### 🪵 Branches
 `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).

.github/workflows/ci-build.yml

@@ -25,15 +25,19 @@ jobs:
           - web-api
           - webhook
     runs-on: ${{ matrix.os }}
+    permissions:
+      contents: read
     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
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          persist-credentials: false
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm --version
@@ -81,20 +85,20 @@ jobs:
         working-directory: packages/${{ matrix.package }}
       - name: Check for coverage report existence
         id: check_coverage
-        uses: andstor/file-existence-action@v3
+        uses: andstor/file-existence-action@076e0072799f4942c8bc574a82233e1e4d13e9d6 # v3.0.0
         with:
           files: packages/${{ matrix.package }}/coverage/lcov.info
       - name: Upload code coverage
         if: matrix.node-version == '22.x' && matrix.os == 'ubuntu-latest' && steps.check_coverage.outputs.files_exists == 'true'
-        uses: codecov/codecov-action@v5
+        uses: codecov/codecov-action@18283e04ce6e62d37312384ff67231eb8fd56d24 # v5.4.3
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           directory: packages/${{ matrix.package }}/coverage
           flags: ${{ matrix.package }}
           verbose: true
       - name: Upload test results to Codecov
         if: ${{ !cancelled() }}
-        uses: codecov/test-results-action@v1
+        uses: codecov/test-results-action@47f89e9acb64b76debcd5ea40642d25a4adced9f # v1.1.1
         with:
           file: packages/${{ matrix.package }}/coverage/test-results.xml
           flags: ${{ matrix.node-version }},${{ matrix.os }},${{ matrix.package }}

.github/workflows/docs-deploy.yml

@@ -4,20 +4,19 @@
 
 name: Close stale issues and PRs
 
-on: 
+on:
   workflow_dispatch:
   schedule:
-    - cron: '0 0 * * 1'
-  
-permissions:
-  issues: write
-  pull-requests: write
+    - cron: "0 0 * * 1"
 
 jobs:
   stale:
     runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
     steps:
-      - uses: actions/stale@v9.1.0
+      - uses: actions/stale@5bef64f19d7facfb25b37b414482c7164d639639 # v9.1.0
         with:
           days-before-issue-stale: 30
           days-before-issue-close: 10
@@ -30,4 +29,4 @@ jobs:
           exempt-all-milestones: true
           remove-stale-when-updated: true
           enable-statistics: true
-          operations-per-run: 60
+          operations-per-run: 60