Skip to content

Commit a6bcba2

Browse files
fix: update the release instructions (#78)
1 parent 2361b9a commit a6bcba2

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

.github/maintainers_guide.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -139,14 +139,16 @@ Before creating a new release, ensure that everything on a stable branch has
139139
landed, then [run the tests](#run-all-the-unit-tests).
140140

141141
1. Create the commit for the release
142-
1. In `slack_cli_hooks/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).
142+
1. Use the latest supported Python version. Using a [virtual environment](#python-and-friends) is recommended.
143+
2. In `slack_cli_hooks/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).
143144
- Example: if the current version is `1.2.3`, a proper development bump would be `1.2.4.dev0`
144145
- `.dev` will indicate to pip that this is a [Development Release](https://peps.python.org/pep-0440/#developmental-releases)
145146
- Note that the `dev` version can be bumped in development releases: `1.2.4.dev0` -> `1.2.4.dev1`
146-
2. 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)
147+
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)
147148
1. `git checkout -b future-release`
148-
2. `git commit -m 'chore(release): version 1.2.4.dev0'`
149-
3. `git push -u origin future-release`
149+
2. `git add --all` (review files with `git status` before committing)
150+
3. `git commit -m 'chore(release): version 1.2.4.dev0'`
151+
4. `git push -u origin future-release`
150152
2. Create a new GitHub Release
151153
1. Navigate to the [Releases page](https://github.com/slackapi/python-slack-hooks/releases).
152154
2. Click the "Draft a new release" button.
@@ -170,13 +172,15 @@ Before creating a new release, ensure that everything on the `main` branch since
170172
the last tag is in a releasable state! At a minimum, [run the tests](#run-all-the-unit-tests).
171173
172174
1. Create the commit for the release
173-
1. In `slack_cli_hooks/version.py` bump the version number in adherence to [Semantic Versioning](http://semver.org/) and the [Versioning](#versioning-and-tags) section.
174-
2. 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.
175+
1. Use the latest supported Python version. Using a [virtual environment](#python-and-friends) is recommended.
176+
2. In `slack_cli_hooks/version.py` bump the version number in adherence to [Semantic Versioning](http://semver.org/) and the [Versioning](#versioning-and-tags) section.
177+
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.
175178
1. `git checkout -b 1.2.3-release`
176-
2. `git commit -m 'chore(release): version 1.2.3'`
177-
3. `git push -u origin 1.2.3-release`
178-
3. Add relevant labels to the PR and add the PR to a GitHub Milestone.
179-
4. Merge in release PR after getting an approval from at least one maintainer.
179+
2. `git add --all` (review files with `git status` before committing)
180+
3. `git commit -m 'chore(release): version 1.2.3'`
181+
4. `git push -u origin 1.2.3-release`
182+
4. Add relevant labels to the PR and add the PR to a GitHub Milestone.
183+
5. Merge in release PR after getting an approval from at least one maintainer.
180184
2. Create a new GitHub Release
181185
1. Navigate to the [Releases page](https://github.com/slackapi/python-slack-hooks/releases).
182186
2. Click the "Draft a new release" button.

0 commit comments

Comments
 (0)