Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: update release instructions in maintainers guide #1507

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions .github/maintainers_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ $ ./scripts/generate_api_docs.sh

- Use the latest stable Python runtime
- `python -m venv env`
- `python setup.py upload`
- `./scripts/deploy_to_prod_pypi_org.sh`
- Create a GitHub Release. You will select the commit with updated version number (e.g. `version 2.5.0`) to associate with the tag, and name the tag after this version (e.g. `v2.5.0`). This will also serve as a Changelog for the project. Add a description of changes to the Release. Mention Issue and PR #'s and @-mention contributors.

```markdown
Expand All @@ -152,9 +152,13 @@ $ ./scripts/generate_api_docs.sh

**All Changes**

https://github.com/slackapi/python-slack-sdk/compare/{the previous release version tag}...{the release version tag}
* All issues/pull requests: https://github.com/slackapi/python-slack-sdk/milestone/{milestone for the release}
* All changes: https://github.com/slackapi/python-slack-sdk/compare/{the previous release version tag}...{the release version tag}
```

- Close the milestone relating to the Release
- Create the next patch version Milestone. To be used by the following release.

3. (Slack Internal) Communicate the release internally

- Include a link to the GitHub release
Expand Down
Loading