Update release.md to remove outdated info and deprecated links #2127
Conversation
|
🎉 All Contributor License Agreements have been signed. Ready to merge. |
There was a problem hiding this comment.
Pull Request Overview
This PR updates the RELEASE.md documentation to remove outdated release processes and broken links, specifically modernizing the CI/CD workflow documentation by replacing manual git commands with Semaphore CI automation and updating deprecated URLs.
Key Changes:
- Replaced manual git tag creation instructions with Semaphore CI tag-release task
- Updated Semaphore CI URLs from deprecated
confluentinc.semaphoreci.comto currentsemaphore.ci.confluent.io - Removed obsolete sections including manual push instructions and Twitter announcement guidelines
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - **PROJECT**: confluent-kafka-python | ||
| - **GIT_REF**: name of your RC branch (`v0.11.4rc` in this tutorial) | ||
| - **TAG_NAME**: name of the new tag (`v0.11.4rc1-dev1`, for example) | ||
| - You can do a test run (set **dry_run** to true) to verify the output before proceeding with the actual tag creation (set **dry_run** to true). |
There was a problem hiding this comment.
The phrase 'set dry_run to true' is repeated twice in the same sentence. This appears to be a copy-paste error. Consider revising to: 'You can do a test run (set dry_run to true) to verify the output before proceeding with the actual tag creation (set dry_run to false).'
| - You can do a test run (set **dry_run** to true) to verify the output before proceeding with the actual tag creation (set **dry_run** to true). | |
| - You can do a test run (set **dry_run** to true) to verify the output before proceeding with the actual tag creation (set **dry_run** to false). |
| When all CI builds are successful it is time to download all the resulting | ||
| artifacts (wheels) from build's `artifacts` directory (located in the `Artifacts` tab in the build). | ||
|
|
||
| Create a new folder `tools\dl-<tag>` under the repository root, and unzip all artifacts from the downloaded .tgz files there. You should have many artifacts (with .whl suffix) under `tools\dl-<tag>` as we support different operating systems and Python versions. |
There was a problem hiding this comment.
[nitpick] The path separator uses backslashes (tools\dl-<tag>), which are Windows-specific. For cross-platform documentation, consider using forward slashes (tools/dl-<tag>) or explicitly noting the platform-specific path format.
| Create a new folder `tools\dl-<tag>` under the repository root, and unzip all artifacts from the downloaded .tgz files there. You should have many artifacts (with .whl suffix) under `tools\dl-<tag>` as we support different operating systems and Python versions. | |
| Create a new folder `tools/dl-<tag>` under the repository root, and unzip all artifacts from the downloaded .tgz files there. You should have many artifacts (with .whl suffix) under `tools/dl-<tag>` as we support different operating systems and Python versions. |
|
| 5.1 and perform the CANDIDATE ITERATION. | ||
|
|
||
|
|
||
|
|
There was a problem hiding this comment.
Can we add the pip install -i https://test.pypi.org/simple/ "confluent-kafka==<RELEASE.VERSION>" pip install --no-binary "confluent-kafka" -i https://test.pypi.org/simple/ "confluent-kafka==<RELEASE.VERSION>" to the verify section here. We've had two releases recently where the source install path got messed up by typo and didn't get caught that this ensures is checked. You'll need to note that on OSX you need the lib and bin path for librdkafka set as indicated earlier in the readme
What
Checklist
References
JIRA:
Test & Review
Open questions / Follow-ups