You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Bump the version number in adherence to [Semantic Versioning](http://semver.org/) in `slack_sdk/version.py`.
131
131
- Build the docs with `./scripts/docs.sh` and then `./scripts/generate_api_docs.sh`.
132
132
- Create a branch for the release with `git checkout -b v2.5.0`
133
-
- Make a commit that includes the new version number: `git commit -m 'version 2.5.0'`.
133
+
- Make a commit that includes the new version number: `git commit -a -m 'version 2.5.0'`.
134
134
- Open a PR and merge after receiving at least one approval from other maintainers.
135
-
- Create a git tag for the release. For example `git tag v2.5.0`.
136
-
- Push the tag up to github with `git push origin --tags`
137
135
138
136
2. Distribute the release
139
137
140
138
- Use the latest stable Python runtime
141
139
-`python -m venv env`
142
140
-`./scripts/deploy_to_prod_pypi_org.sh`
143
-
- 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.
141
+
- Create a new GitHub Release from the [Releases page](https://github.com/slackapi/python-slack-sdk/releases) by clicking the "Draft a new release" button.
142
+
- Enter the new version number updated from the commit (e.g. `v2.5.0`) into the "Choose a tag" input.
143
+
- Ensure the tag `Target` branch is `main` (e.g `Target:main`).
144
+
- Click the "Create a new tag: x.x.x on publish" button. This won't create your tag immediately.
145
+
- Name the release after the version number updated from the commit (e.g. `version 2.5.0`)
146
+
- Auto-generate the release notes by clicking the "Auto-generate release
147
+
notes" button. This will pull in changes that will be included in your
148
+
release.
149
+
- Edit the resulting notes to ensure they have decent messaging that are
150
+
understandable by non-contributors, but each commit should still have it's
151
+
own line.
152
+
- Ensure that this version adheres to [semantic versioning][semver]. See
153
+
[Versioning](#versioning-and-tags) for correct version format. Version tags
154
+
should match the following pattern: `v2.5.0`.
144
155
145
156
```markdown
146
157
Refer to [v{version} milestone](https://github.com/slackapi/python-slack-sdk/milestone/{TODO}?closed=1) to know the complete list of the issues resolved by this release.
-[ ]**slack_sdk.audit_logs** (Audit Logs API client)
15
19
-[ ]**slack_sdk.rtm_v2** (RTM client)
16
20
-[ ]`/docs-src` (Documents, have you run `./scripts/docs.sh`?)
17
-
-[ ]`/docs-src-v2` (Documents, have you run `./scripts/docs-v2.sh`?)
18
21
-[ ]`/tutorial` (PythOnBoardingBot tutorial)
19
22
-[ ]`tests`/`integration_tests` (Automated tests for this library)
20
23
21
-
## Requirements (place an `x` in each `[ ]`)
24
+
## Requirements <!--place an `x` in each `[ ]`-->
22
25
23
26
-[ ] I've read and understood the [Contributing Guidelines](https://github.com/slackapi/python-slack-sdk/blob/main/.github/contributing.md) and have done my best effort to follow them.
24
27
-[ ] I've read and agree to the [Code of Conduct](https://slackhq.github.io/code-of-conduct).
0 commit comments