Skip to content

Commit 8a8f285

Browse files
fix: update the release instructions (#1400)
1 parent 9cba291 commit 8a8f285

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

.github/maintainers_guide.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -147,15 +147,17 @@ Before creating a new release, ensure that everything on a stable branch has
147147
landed, then [run the tests](#run-all-the-unit-tests).
148148

149149
1. Create the commit for the release
150-
1. In `slack_bolt/version.py` bump the version number in adherence to [Semantic Versioning](http://semver.org/) and [Developmental Release](https://peps.python.org/pep-0440/#developmental-releases).
150+
1. Use the latest supported Python version. Using a [virtual environment](#python-and-friends) is recommended.
151+
2. In `slack_bolt/version.py` bump the version number in adherence to [Semantic Versioning](http://semver.org/) and [Developmental Release](https://peps.python.org/pep-0440/#developmental-releases).
151152
- Example: if the current version is `1.2.3`, a proper development bump would be `1.2.4.dev0`
152153
- `.dev` will indicate to pip that this is a [Development Release](https://peps.python.org/pep-0440/#developmental-releases)
153154
- Note that the `dev` version can be bumped in development releases: `1.2.4.dev0` -> `1.2.4.dev1`
154-
2. Build the docs with `./scripts/generate_api_docs.sh`.
155-
3. Commit with a message including the new version number. For example `1.2.4.dev0` & push the commit to a branch where the development release will live (create it if it does not exist)
155+
3. Build the docs with `./scripts/generate_api_docs.sh`.
156+
4. Commit with a message including the new version number. For example `1.2.4.dev0` & push the commit to a branch where the development release will live (create it if it does not exist)
156157
1. `git checkout -b future-release`
157-
2. `git commit -m 'chore(release): version 1.2.4.dev0'`
158-
3. `git push -u origin future-release`
158+
2. `git add --all` (review files with `git status` before committing)
159+
3. `git commit -m 'chore(release): version 1.2.4.dev0'`
160+
4. `git push -u origin future-release`
159161
2. Create a new GitHub Release
160162
1. Navigate to the [Releases page](https://github.com/slackapi/bolt-python/releases).
161163
2. Click the "Draft a new release" button.
@@ -179,14 +181,16 @@ Before creating a new release, ensure that everything on the `main` branch since
179181
the last tag is in a releasable state! At a minimum, [run the tests](#run-all-the-unit-tests).
180182
181183
1. Create the commit for the release
182-
1. In `slack_bolt/version.py` bump the version number in adherence to [Semantic Versioning](http://semver.org/) and the [Versioning](#versioning-and-tags) section.
183-
2. Build the docs with `./scripts/generate_api_docs.sh`.
184-
3. Commit with a message including the new version number. For example `1.2.3` & push the commit to a branch and create a PR to sanity check.
184+
1. Use the latest supported Python version. Using a [virtual environment](#python-and-friends) is recommended.
185+
2. In `slack_bolt/version.py` bump the version number in adherence to [Semantic Versioning](http://semver.org/) and the [Versioning](#versioning-and-tags) section.
186+
3. Build the docs with `./scripts/generate_api_docs.sh`.
187+
4. Commit with a message including the new version number. For example `1.2.3` & push the commit to a branch and create a PR to sanity check.
185188
1. `git checkout -b 1.2.3-release`
186-
2. `git commit -m 'chore(release): version 1.2.3'`
187-
3. `git push -u origin 1.2.3-release`
188-
4. Add relevant labels to the PR and add the PR to a GitHub Milestone.
189-
5. Merge in release PR after getting an approval from at least one maintainer.
189+
2. `git add --all` (review files with `git status` before committing)
190+
3. `git commit -m 'chore(release): version 1.2.3'`
191+
4. `git push -u origin 1.2.3-release`
192+
5. Add relevant labels to the PR and add the PR to a GitHub Milestone.
193+
6. Merge in release PR after getting an approval from at least one maintainer.
190194
2. Create a new GitHub Release
191195
1. Navigate to the [Releases page](https://github.com/slackapi/bolt-python/releases).
192196
2. Click the "Draft a new release" button.

0 commit comments

Comments
 (0)