Skip to content

Commit 092fefb

Browse files
committed
docs: Add maintainers guide documenting Bolt vendoring slash commands
1 parent bad031c commit 092fefb

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

.github/MAINTAINERS_GUIDE.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Maintainers Guide
2+
3+
## Using Bolt Framework Development Builds
4+
5+
This repo vendors a pre-release build of [`slack-bolt`](https://github.com/slackapi/bolt-python) from the `main` branch. The `.whl` wheel lives in `vendor/` and is referenced by each implementation's `requirements.txt`.
6+
7+
Two [Claude Code slash commands](https://docs.anthropic.com/en/docs/claude-code/slash-commands) are available to manage this:
8+
9+
### `/vendor-bolt` — Update the vendored wheel
10+
11+
Clones bolt-python `main`, builds a wheel with a local version identifier (e.g. `1.2.3+abc1234`), replaces the wheel in `vendor/`, and updates all `requirements.txt` references. Use this to pull in the latest unreleased bolt-python changes.
12+
13+
### `/unvendor-bolt` — Switch to the published PyPI package
14+
15+
Removes the `vendor/` directory, replaces the wheel reference in all `requirements.txt` and `pyproject.toml` files with the latest `slack-bolt` version from PyPI, and re-enables Dependabot updates. Use this when the vendored changes have been released and the repo should track the public package.
16+
17+
Both commands leave changes uncommitted for review.

0 commit comments

Comments
 (0)