Skip to content

Commit 67cc8b6

Browse files
committed
Merge branch 'main' of https://github.com/slackapi/node-slack-sdk into feat-work-objects
2 parents c3cef1f + 893a37d commit 67cc8b6

23 files changed

Lines changed: 102 additions & 33 deletions

File tree

.github/maintainers_guide.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -52,17 +52,17 @@ Releasing can feel intimidating at first, but rest assured: if you make a mistak
5252

5353
4. For each package to be released, run `npm run test` to verify that tests are passing and code is free of linting errors.
5454

55-
5. Generate the reference docs for that package by running `npm run docs`.
55+
5. On our 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))
5656

57-
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))
57+
- Generate the reference docs for that package by running `npm run docs`.
5858

5959
- Make a single commit for the version(s) bump, following the format in: ([Example](https://github.com/slackapi/node-slack-sdk/commit/1503609d79abf035e9e21bad7360e124e4211594))
6060

6161
- Create a pull request for the version change ([Example](https://github.com/slackapi/node-slack-sdk/pull/1059))
6262

6363
- Add appropriate labels on the PR, including `release`
6464

65-
7. Once the PR has been approved and tests have passed, merge it into the main repository.
65+
6. Once the PR has been approved and tests have passed, merge it into the main repository.
6666

6767
- Check out your local `main` branch and update it to get the latest changes: `git checkout main && git pull origin main`
6868

@@ -77,15 +77,15 @@ Releasing can feel intimidating at first, but rest assured: if you make a mistak
7777

7878
- Run `npm publish . --otp YOUR_OTP_CODE`. To generate an OTP (One Time Password), use your password generator of choice (Duo, 1Password)
7979

80-
9. Close GitHub Milestone(s)
80+
8. Close GitHub Milestone(s)
8181

8282
- Close the relevant GitHub Milestone(s) for the release(s)
8383

8484
- 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
8585

8686
- Move any unfinished, open issues to the next GitHub Milestone
8787

88-
10. Create GitHub Release(s) with release notes
88+
9. Create GitHub Release(s) with release notes
8989

9090
- From the repository, navigate to the **Releases** section and draft a new release
9191

@@ -97,7 +97,7 @@ Releasing can feel intimidating at first, but rest assured: if you make a mistak
9797

9898
- Once the release notes are ready, click the "Publish Release" button to make them public
9999

100-
11. Communicate the release (as appropriate)
100+
10. Communicate the release (as appropriate)
101101

102102
- **Internal**
103103

@@ -138,19 +138,19 @@ Releasing can feel intimidating at first, but rest assured: if you make a mistak
138138

139139
- Push the new tag up to origin: `git push --tags origin`
140140

141-
5. Publish the release to npm
141+
6. Publish the release to npm
142142

143143
- Run `npm publish --tag <dist-tag> . --otp YOUR_OTP_CODE`
144144

145145
- `<dist-tag>` should be a label representative of the beta release. It could be feature-specific (i.e. `feat-token-rotation`) or it can be a generic release candidate (i.e. `2.5.0rc`). Whatever you decide: it must _not_ be `latest`, as that is reserved for non-beta releases.
146146

147147
- To generate an OTP (One Time Password), use your password generator of choice (Duo, 1Password)
148148

149-
6. Test that the publish was successful
149+
7. Test that the publish was successful
150150

151151
- Run `npm info <PACKAGE_NAME> dist-tags`
152152

153-
7. Create GitHub Release(s) with release notes
153+
8. Create GitHub Release(s) with release notes
154154

155155
- From the repository, navigate to the **Releases** section and draft a new release
156156

@@ -163,7 +163,7 @@ Releasing can feel intimidating at first, but rest assured: if you make a mistak
163163
### 🔖 Versioning and Tags
164164
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.
165165

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.
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/tools/slack-cli/) itself.
167167

168168
### 🪵 Branches
169169
`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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ jobs:
3333
run: |
3434
git config --global core.autocrlf false
3535
git config --global core.eol lf
36-
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
36+
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
3737
with:
3838
persist-credentials: false
3939
- name: Use Node.js ${{ matrix.node-version }}
@@ -90,7 +90,7 @@ jobs:
9090
files: packages/${{ matrix.package }}/coverage/lcov.info
9191
- name: Upload code coverage
9292
if: matrix.node-version == '22.x' && matrix.os == 'ubuntu-latest' && steps.check_coverage.outputs.files_exists == 'true'
93-
uses: codecov/codecov-action@18283e04ce6e62d37312384ff67231eb8fd56d24 # v5.4.3
93+
uses: codecov/codecov-action@fdcc8476540edceab3de004e990f80d881c6cc00 # v5.5.0
9494
with:
9595
token: ${{ secrets.CODECOV_TOKEN }}
9696
directory: packages/${{ matrix.package }}/coverage

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.1.0+cli.2.32.2
1+
# @slack/cli-test v2.2.0+cli.2.32.2
22

33
## Classes
44

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

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
const SlackCLI: object;
77
```
88

9-
Defined in: [cli/index.ts:21](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/cli/index.ts#L21)
9+
Defined in: [cli/index.ts:22](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/cli/index.ts#L22)
1010

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

@@ -815,3 +815,23 @@ update: (args) => Promise<string>;
815815
`Promise`\<`string`\>
816816

817817
command output
818+
819+
### version
820+
821+
```ts
822+
version: object;
823+
```
824+
825+
#### version.version()
826+
827+
```ts
828+
version: () => Promise<string>;
829+
```
830+
831+
`slack version`
832+
833+
##### Returns
834+
835+
`Promise`\<`string`\>
836+
837+
command output

docs/english/reference/oauth/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# @slack/oauth v3.0.3
1+
# @slack/oauth v3.0.4
22

33
## Enumerations
44

docs/english/reference/rtm-api/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# @slack/rtm-api v7.0.3
1+
# @slack/rtm-api v7.0.4
22

33
## Enumerations
44

docs/english/reference/socket-mode/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# @slack/socket-mode v2.0.4
1+
# @slack/socket-mode v2.0.5
22

33
## Enumerations
44

examples/openid-connect/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"license": "MIT",
1111
"repository": "slackapi/node-slack-sdk",
1212
"dependencies": {
13-
"@koa/router": "^13.0.0",
13+
"@koa/router": "^14.0.0",
1414
"@slack/web-api": "^7.3.4",
1515
"jsonwebtoken": "^9.0.2",
1616
"koa": "^3.0.0",

packages/cli-test/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@slack/cli-test",
3-
"version": "2.1.0+cli.2.32.2",
3+
"version": "2.2.0+cli.2.32.2",
44
"description": "Node.js bindings for the Slack CLI for use in automated testing",
55
"author": "Salesforce, Inc.",
66
"license": "MIT",
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
import sinon from 'sinon';
2+
3+
import { mockProcess } from '../../utils/test';
4+
import { shell } from '../shell';
5+
import version from './version';
6+
7+
describe('version commands', () => {
8+
const sandbox = sinon.createSandbox();
9+
let spawnSpy: sinon.SinonStub;
10+
11+
beforeEach(() => {
12+
const process = mockProcess();
13+
spawnSpy = sandbox.stub(shell, 'spawnProcess').returns({
14+
command: 'version',
15+
finished: true,
16+
output: 'Using slack v3.4.5',
17+
process,
18+
});
19+
sandbox.stub(shell, 'checkIfFinished').resolves();
20+
});
21+
afterEach(() => {
22+
sandbox.restore();
23+
});
24+
25+
describe('version method', () => {
26+
it('should invoke `version`', async () => {
27+
const actual = await version.version();
28+
sandbox.assert.calledWith(spawnSpy, sinon.match.string, sinon.match.array.contains(['version']));
29+
sinon.assert.match(actual, 'v3.4.5');
30+
});
31+
});
32+
});

0 commit comments

Comments
 (0)