docs: include milestones and labels with release steps #63
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -89,14 +89,17 @@ This project uses [mypy](https://mypy.readthedocs.io/en/stable/index.html) to ch | |
| If you want to test the package locally you can. | ||
|
|
||
| 1. Build the package locally | ||
|
|
||
| - Run | ||
|
|
||
| ```zsh | ||
| scripts/build_pypi_package.sh | ||
| ``` | ||
|
|
||
| - This will create a `.whl` file in the `./dist` folder | ||
|
|
||
| 2. Use the built package | ||
|
|
||
| - Example `/dist/slack_cli_hooks-1.2.3-py2.py3-none-any.whl` was created | ||
| - From anywhere on your machine you can install this package to a project with | ||
|
|
||
|
|
@@ -130,7 +133,7 @@ landed, then [run the tests](#run-all-the-unit-tests). | |
| - Bump the version number in adherence to | ||
| [Semantic Versioning](http://semver.org/) and | ||
| [Developmental Release](https://peps.python.org/pep-0440/#developmental-releases) | ||
| in `slack_cli_hooks/version.py` | ||
| - Example the current version is `1.2.3` a proper development bump would be | ||
| `1.2.3.dev0` | ||
| - `.dev` will indicate to pip that this is a | ||
|
|
@@ -147,7 +150,7 @@ landed, then [run the tests](#run-all-the-unit-tests). | |
| [Releases page](https://github.com/slackapi/python-slack-hooks/releases) by | ||
| clicking the "Draft a new release" button. | ||
| 3. Input the version manually into the "Choose a tag" input. You must use the | ||
| same version found in `slack_cli_hooks/version.py` | ||
|
|
||
| - After you input the new version, click the "Create a new tag: x.x.x on | ||
| publish" button. This won't create your tag immediately. | ||
|
|
@@ -183,18 +186,19 @@ the last tag is in a releasable state! At a minimum, | |
|
|
||
| 1. Create the commit for the release | ||
| - Bump the version number in adherence to | ||
| [Semantic Versioning](http://semver.org/) in `slack_cli_hooks/version.py` | ||
| - 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. | ||
| - `git checkout -b 1.2.3-release` | ||
| - `git commit -m 'chore(release): tag version 1.2.3'` | ||
|
There was a problem hiding this comment. 👁️🗨️ Preferring the conventional commit here: https://www.conventionalcommits.org/en/v1.0.0/ There was a problem hiding this comment. Nice 💯 I like this |
||
| - `git push {your-fork} 1.2.3-release` | ||
| - Add relevant labels to the PR and add the PR to a GitHub Milestone. | ||
| - Merge in release PR after getting an approval from at least one maintainer. | ||
| 2. Create a new GitHub Release from the | ||
| [Releases page](https://github.com/slackapi/python-slack-hooks/releases) by | ||
| clicking the "Draft a new release" button. | ||
| 3. Input the version manually into the "Choose a tag" input. You must use the | ||
| same version found in `slack_cli_hooks/version.py` | ||
|
|
||
|
|
||
| - After you input the version, click the "Create a new tag: x.x.x on publish" | ||
| button. This won't create your tag immediately. | ||
|
|
@@ -216,9 +220,10 @@ the last tag is in a releasable state! At a minimum, | |
| 7. Publish the release by clicking the "Publish release" button! | ||
| 8. After a few minutes, the corresponding version will be available on | ||
| <https://pypi.org/project/slack-cli-hooks/>. | ||
| 9. Close the current GitHub Milestone and create one for the next minor version. | ||
| 10. (Slack Internal) Communicate the release internally | ||
| - Include a link to the GitHub release | ||
| 11. (Slack Internal) Tweet by @SlackAPI | ||
| - Not necessary for patch updates, might be needed for minor updates, | ||
| definitely needed for major updates. Include a link to the GitHub release | ||
|
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🔍 Autoformatting from the editor but no change to rendered markdown outputs AFAICT!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One of the oldest ideas on my task list is to find a markdown formatter that we could use across all our projects, everyone seems to have their own 🤔
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would be so glad to share a matching formatter for sake of a consistent edits! It's sometimes difficult to ignore the unstaged changes this can cause otherwise...