Skip to content

Commit 998ee04

Browse files
fix: improve the release instructions (#1792)
1 parent 21ac4f7 commit 998ee04

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
@@ -175,15 +175,17 @@ Before creating a new release, ensure that everything on a stable branch has
175175
landed, then [run the tests](#unit-tests).
176176

177177
1. Create the commit for the release
178-
1. In `slack_sdk/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).
178+
1. Use the latest supported Python version. Using a [virtual environment](#python-and-friends) is recommended.
179+
2. In `slack_sdk/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).
179180
- Example: if the current version is `1.2.3`, a proper development bump would be `1.2.4.dev0`
180181
- `.dev` will indicate to pip that this is a [Development Release](https://peps.python.org/pep-0440/#developmental-releases)
181182
- Note that the `dev` version can be bumped in development releases: `1.2.4.dev0` -> `1.2.4.dev1`
182-
2. Build the docs with `./scripts/generate_api_docs.sh`.
183-
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)
183+
3. Build the docs with `./scripts/generate_api_docs.sh`.
184+
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)
184185
1. `git checkout -b future-release`
185-
2. `git commit -m 'chore(release): version 1.2.4.dev0'`
186-
3. `git push -u origin future-release`
186+
2. `git add --all` (review files with `git status` before committing)
187+
3. `git commit -m 'chore(release): version 1.2.4.dev0'`
188+
4. `git push -u origin future-release`
187189
2. Create a new GitHub Release
188190
1. Navigate to the [Releases page](https://github.com/slackapi/python-slack-sdk/releases).
189191
2. Click the "Draft a new release" button.
@@ -207,14 +209,16 @@ Before creating a new release, ensure that everything on the `main` branch since
207209
the last tag is in a releasable state! At a minimum, [run the tests](#unit-tests).
208210
209211
1. Create the commit for the release
210-
1. In `slack_sdk/version.py` bump the version number in adherence to [Semantic Versioning](http://semver.org/) and the [Versioning](#versioning-and-tags) section.
211-
2. Build the docs with `./scripts/generate_api_docs.sh`.
212-
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.
212+
1. Use the latest supported Python version. Using a [virtual environment](#python-and-friends) is recommended.
213+
2. In `slack_sdk/version.py` bump the version number in adherence to [Semantic Versioning](http://semver.org/) and the [Versioning](#versioning-and-tags) section.
214+
3. Build the docs with `./scripts/generate_api_docs.sh`.
215+
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.
213216
1. `git checkout -b 1.2.3-release`
214-
2. `git commit -m 'chore(release): version 1.2.3'`
215-
3. `git push -u origin 1.2.3-release`
216-
4. Add relevant labels to the PR and add the PR to a GitHub Milestone.
217-
5. Merge in release PR after getting an approval from at least one maintainer.
217+
2. `git add --all` (review files with `git status` before committing)
218+
3. `git commit -m 'chore(release): version 1.2.3'`
219+
4. `git push -u origin 1.2.3-release`
220+
5. Add relevant labels to the PR and add the PR to a GitHub Milestone.
221+
6. Merge in release PR after getting an approval from at least one maintainer.
218222
2. Create a new GitHub Release
219223
1. Navigate to the [Releases page](https://github.com/slackapi/python-slack-sdk/releases).
220224
2. Click the "Draft a new release" button.

0 commit comments

Comments
 (0)