You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/maintainers_guide.md
+16-12Lines changed: 16 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -175,15 +175,17 @@ Before creating a new release, ensure that everything on a stable branch has
175
175
landed, then [run the tests](#unit-tests).
176
176
177
177
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).
179
180
- Example: if the current version is `1.2.3`, a proper development bump would be `1.2.4.dev0`
180
181
- `.dev` will indicate to pip that this is a [Development Release](https://peps.python.org/pep-0440/#developmental-releases)
181
182
- 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)
184
185
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`
187
189
2. Create a new GitHub Release
188
190
1. Navigate to the [Releases page](https://github.com/slackapi/python-slack-sdk/releases).
189
191
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
207
209
the last tag is in a releasable state! At a minimum, [run the tests](#unit-tests).
208
210
209
211
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.
213
216
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.
218
222
2. Create a new GitHub Release
219
223
1. Navigate to the [Releases page](https://github.com/slackapi/python-slack-sdk/releases).
0 commit comments