Update Releasing section of Maintainers' Guide#1125
Merged
seratch merged 1 commit intoslackapi:mainfrom Oct 8, 2021
Merged
Conversation
misscoded
commented
Oct 8, 2021
| - Bump the version number in adherence to [Semantic Versioning](http://semver.org/) in `slack_sdk/version.py`. | ||
| - Build the docs with `./scripts/docs.sh`. | ||
| - Cut off a branch for the release with `git branch -b v2.5.0-release` | ||
| - Set the version in `slack/version.py` (e.g., `2.5.0`) |
Contributor
Author
There was a problem hiding this comment.
Removed this because as far as we could tell, this is auto-updated now.
misscoded
commented
Oct 8, 2021
| - Push the commit to a branch and create a PR to sanity check. | ||
| - Merge in release PR after receiving at least one approval from other maintainers. | ||
| - Create a git tag for the release. For example `git tag 2.5.0`. | ||
| - Create a branch for the release with `git checkout -b v2.5.0` |
Contributor
Author
There was a problem hiding this comment.
We looked to pattern match from recent history and didn't see appending of the -release but want to verify this bit.
Codecov Report
@@ Coverage Diff @@
## main #1125 +/- ##
==========================================
+ Coverage 88.05% 88.08% +0.02%
==========================================
Files 110 110
Lines 10681 10681
==========================================
+ Hits 9405 9408 +3
+ Misses 1276 1273 -3
Continue to review full report at Codecov.
|
seratch
approved these changes
Oct 8, 2021
Contributor
seratch
left a comment
There was a problem hiding this comment.
Thanks for fixing the outdated parts!
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Minor updates to the Releasing section of the Maintainers' Guide to reflect the current process.
Requirements (place an
xin each[ ])python3 -m venv .venv && source .venv/bin/activate && ./scripts/run_validation.shafter making the changes.