Skip to content

ci: update package lockfile and docs with changesets release #2559

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 1 commit into from
Apr 23, 2026
+4 −3
Merged

ci: update package lockfile and docs with changesets release #2559

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/maintainers_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,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. Use `npm run docs` to generate documentation and `npm install` to update versions in the `package-lock.json` file.
2. **Review the release PR**: Verify that version bumps match expectations, `CHANGELOG` entries are clear, and CI checks pass on the `main` branch.

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
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ jobs:
with:
commit: "chore: release"
title: "chore: release"
version: npm run changeset -- version
version: npm run version
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Expand Down
3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@
"docs": "npm run docs --workspaces --if-present",
"lint": "npx @biomejs/biome check packages",
"lint:fix": "npx @biomejs/biome check --write packages",
"test": "npm test --workspaces --if-present"
"test": "npm test --workspaces --if-present",
"version": "npm run changeset version && npm install && npm run docs"
Copy link
Copy Markdown
Member Author

@zimeg zimeg Apr 23, 2026

Choose a reason for hiding this comment

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

📣 note: We prefer this script alongside releasing in CI such that:

$ npm run version
  • Updates the CHANGELOG.md
  • Updates the lockfile
  • Updates the generated reference

},
"devDependencies": {
"@biomejs/biome": "^2.0.5",
Expand Down