Skip to content

Commit 628509f

Browse files
Document the backporting of bug fixes
1 parent 83b0127 commit 628509f

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

doc/release.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,18 @@ So, you want to release the `X.Y.Z` version of astroid ?
1010
2. Check the result (Do `git diff vX.Y.Z-1 ChangeLog` in particular).
1111
3. Install the release dependencies `pip3 install pre-commit tbump`
1212
4. Bump the version and release by using `tbump X.Y.Z --no-push`.
13-
5. Push the tag.
13+
5. Push the tag, push a `X.Y` branch.
1414
6. Release the version on GitHub with the same name as the tag and copy and paste the
1515
appropriate changelog in the description. This trigger the pypi release.
1616

1717
## Post release
1818

19+
### Backport fixes from main
20+
21+
When a crash or a bug is fixed on the main branch, and it needs backport, make sure that
22+
the changelog is for the patch version `X.Y-1.Z'` then after the PR is merged
23+
cherry-pick the commit on the `X.Y-1` branch and do a release for `X.Y-1.Z`.
24+
1925
### Back to a dev version
2026

2127
Move back to a dev version with `tbump`:

0 commit comments

Comments
 (0)