From ca5ae58e8d1ea3770c4e4c93c9cd52583a98f37d Mon Sep 17 00:00:00 2001 From: William Bergamin Date: Thu, 4 Jul 2024 13:54:09 -0400 Subject: [PATCH 1/2] fix: small maintainer instructions --- .github/maintainers_guide.md | 19 +++++++++++++++---- .github/pull_request_template.md | 13 ++++++++----- 2 files changed, 23 insertions(+), 9 deletions(-) diff --git a/.github/maintainers_guide.md b/.github/maintainers_guide.md index e3fde6e39..a03547dc3 100644 --- a/.github/maintainers_guide.md +++ b/.github/maintainers_guide.md @@ -130,17 +130,28 @@ $ ./scripts/generate_api_docs.sh - Bump the version number in adherence to [Semantic Versioning](http://semver.org/) in `slack_sdk/version.py`. - Build the docs with `./scripts/docs.sh` and then `./scripts/generate_api_docs.sh`. - Create a branch for the release with `git checkout -b v2.5.0` - - Make a commit that includes the new version number: `git commit -m 'version 2.5.0'`. + - Make a commit that includes the new version number: `git commit -a -m 'version 2.5.0'`. - Open a PR and merge after receiving at least one approval from other maintainers. - - Create a git tag for the release. For example `git tag v2.5.0`. - - Push the tag up to github with `git push origin --tags` 2. Distribute the release - Use the latest stable Python runtime - `python -m venv env` - `./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. + - 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. + - Enter the new version number updated from the commit (e.g. `v2.5.0`) into the "Choose a tag" input. + - Ensure the tag `Target` branch is `main` (e.g `Target:main`). + - Click the "Create a new tag: x.x.x on publish" button. This won't create your tag immediately. + - Name the release after the version number updated from the commit (e.g. `version 2.5.0`) + - Auto-generate the release notes by clicking the "Auto-generate release + notes" button. This will pull in changes that will be included in your + release. + - Edit the resulting notes to ensure they have decent messaging that are + understandable by non-contributors, but each commit should still have it's + own line. + - Ensure that this version adheres to [semantic versioning][semver]. See + [Versioning](#versioning-and-tags) for correct version format. Version tags + should match the following pattern: `v2.5.0`. ```markdown 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. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index f56b5fdee..c344356ad 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,8 +1,12 @@ ## Summary -(Describe the goal of this PR. Mention any related issue numbers) + -### Category (place an `x` in each of the `[ ]`) +### Testing + + + +### Category - [ ] **slack_sdk.web.WebClient (sync/async)** (Web API client) - [ ] **slack_sdk.webhook.WebhookClient (sync/async)** (Incoming Webhook, response_url sender) @@ -13,12 +17,11 @@ - [ ] **slack_sdk.scim** (SCIM API client) - [ ] **slack_sdk.audit_logs** (Audit Logs API client) - [ ] **slack_sdk.rtm_v2** (RTM client) -- [ ] `/docs-src` (Documents, have you run `./scripts/docs.sh`?) -- [ ] `/docs-src-v2` (Documents, have you run `./scripts/docs-v2.sh`?) +- [ ] `/docs-src` (Documents, have you run `./scripts/docs.sh`/`./scripts/generate_api_docs.sh`?) - [ ] `/tutorial` (PythOnBoardingBot tutorial) - [ ] `tests`/`integration_tests` (Automated tests for this library) -## Requirements (place an `x` in each `[ ]`) +## Requirements - [ ] 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. - [ ] I've read and agree to the [Code of Conduct](https://slackhq.github.io/code-of-conduct). From 7e506f4bd53d60d21ddc03e6e4f9f9911fdcdc66 Mon Sep 17 00:00:00 2001 From: William Bergamin Date: Fri, 5 Jul 2024 10:12:18 -0400 Subject: [PATCH 2/2] Remove reference to ./scripts/generate_api_docs.sh --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index c344356ad..3d0e00e5d 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -17,7 +17,7 @@ - [ ] **slack_sdk.scim** (SCIM API client) - [ ] **slack_sdk.audit_logs** (Audit Logs API client) - [ ] **slack_sdk.rtm_v2** (RTM client) -- [ ] `/docs-src` (Documents, have you run `./scripts/docs.sh`/`./scripts/generate_api_docs.sh`?) +- [ ] `/docs-src` (Documents, have you run `./scripts/docs.sh`?) - [ ] `/tutorial` (PythOnBoardingBot tutorial) - [ ] `tests`/`integration_tests` (Automated tests for this library)