🧭 Patch release guide #3512
🧭 Patch release guide #3512
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates the CONTRIBUTING.md guide to include new instructions for making patch releases and clarifies the major/minor release process. The key changes include:
- Introducing a "Major/Minor Release" section with updated versioning instructions.
- Updating commit instructions to include additional files such as trl/init.py and a workflow file.
- Adding a comprehensive "Making a patch release" section with step-by-step commands for cherry-picking commits, updating versions, and publishing releases.
| @@ -646,3 +647,121 @@ twine upload dist/* | |||
| 5. Once the pull request is approved, merge it into `main`. | |||
|
|
|||
| 6. The codebase is now ready for the next development cycle, inform the team in the #trl-internal channel. | |||
|
|
|||
|
|
|||
| ## Making a patch release | |||
There was a problem hiding this comment.
[nitpick] Consider adding a brief introductory note for the patch release section that explains its purpose and context to help users understand when to follow these steps.
Copilot uses AI. Check for mistakes.
|
|
||
| - `trl/__init__.py` | ||
| ```diff | ||
| - __version__ = "{major}.{minor}.{patch-1}" |
There was a problem hiding this comment.
[nitpick] Clarify the use of the placeholders (e.g., {patch-1} to {patch}) in the versioning instructions. This could prevent any potential confusion about how version numbers should be incremented during a patch release.
Copilot uses AI. Check for mistakes.
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
What does this PR do?
Fixes # (issue)
Before submitting
Pull Request section?
to it if that's the case.
Who can review?
Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.