@@ -89,14 +89,17 @@ This project uses [mypy](https://mypy.readthedocs.io/en/stable/index.html) to ch
8989If you want to test the package locally you can.
9090
91911 . Build the package locally
92+
9293 - Run
9394
9495 ``` zsh
9596 scripts/build_pypi_package.sh
9697 ```
9798
9899 - This will create a ` .whl` file in the ` ./dist` folder
100+
991012. Use the built package
102+
100103 - Example ` /dist/slack_cli_hooks-1.2.3-py2.py3-none-any.whl` was created
101104 - From anywhere on your machine you can install this package to a project with
102105
@@ -130,7 +133,7 @@ landed, then [run the tests](#run-all-the-unit-tests).
130133 - Bump the version number in adherence to
131134 [Semantic Versioning](http://semver.org/) and
132135 [Developmental Release](https://peps.python.org/pep-0440/# developmental-releases)
133- in ` slack_bolt /version.py`
136+ in ` slack_cli_hooks /version.py`
134137 - Example the current version is ` 1.2.3` a proper development bump would be
135138 ` 1.2.3.dev0`
136139 - ` .dev` will indicate to pip that this is a
@@ -147,7 +150,7 @@ landed, then [run the tests](#run-all-the-unit-tests).
147150 [Releases page](https://github.com/slackapi/python-slack-hooks/releases) by
148151 clicking the " Draft a new release" button.
1491523. Input the version manually into the " Choose a tag" input. You must use the
150- same version found in ` slack_bolt /version.py`
153+ same version found in ` slack_cli_hooks /version.py`
151154
152155 - After you input the new version, click the " Create a new tag: x.x.x on
153156 publish" button. This won' t create your tag immediately.
@@ -183,18 +186,19 @@ the last tag is in a releasable state! At a minimum,
183186
1841871. Create the commit for the release
185188 - Bump the version number in adherence to
186- [Semantic Versioning](http://semver.org/) in ` slack_bolt /version.py`
189+ [Semantic Versioning](http://semver.org/) in ` slack_cli_hooks /version.py`
187190 - Commit with a message including the new version number. For example ` 1.2.3`
188191 & Push the commit to a branch and create a PR to sanity check.
189192 - ` git checkout -b 1.2.3-release`
190- - ` git commit -m ' version 1.2.3' `
193+ - ` git commit -m ' chore(release): tag version 1.2.3' `
191194 - ` git push {your-fork} 1.2.3-release`
195+ - Add relevant labels to the PR and add the PR to a GitHub Milestone.
192196 - Merge in release PR after getting an approval from at least one maintainer.
1931972. Create a new GitHub Release from the
194198 [Releases page](https://github.com/slackapi/python-slack-hooks/releases) by
195199 clicking the " Draft a new release" button.
1962003. Input the version manually into the " Choose a tag" input. You must use the
197- same version found in ` slack_bolt /version.py`
201+ same version found in ` slack_cli_hooks /version.py`
198202
199203 - After you input the version, click the " Create a new tag: x.x.x on publish"
200204 button. This won' t create your tag immediately.
@@ -216,9 +220,10 @@ the last tag is in a releasable state! At a minimum,
2162207. Publish the release by clicking the " Publish release" button!
2172218. After a few minutes, the corresponding version will be available on
218222 < https://pypi.org/project/slack-cli-hooks/> .
219- 9. (Slack Internal) Communicate the release internally
220- - Include a link to the GitHub release
221- 10. (Slack Internal) Tweet by @SlackAPI
223+ 9. Close the current GitHub Milestone and create one for the next minor version.
224+ 10. (Slack Internal) Communicate the release internally
225+ - Include a link to the GitHub release
226+ 11. (Slack Internal) Tweet by @SlackAPI
222227 - Not necessary for patch updates, might be needed for minor updates,
223228 definitely needed for major updates. Include a link to the GitHub release
224229
0 commit comments