Skip to content

Commit 647ab0e

Browse files
committed
add docs on patch vs major/minor release
1 parent 88aeeca commit 647ab0e

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

mkdocs/docs/how-to-release.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,30 @@ Update the version in `pyproject.toml` and `pyiceberg/__init__.py` to match the
7070

7171
## Publishing a Release Candidate (RC)
7272

73+
### Release Types
74+
75+
#### Major/Minor Release
76+
77+
* Use the `main` branch for the release.
78+
* Includes new features, enhancements, and any necessary backward-compatible changes.
79+
* Examples: `0.8.0`, `0.9.0`, `1.0.0`.
80+
81+
#### Patch Release
82+
83+
* Use the branch corresponding to the patch version, such as `pyiceberg-0.8.x`.
84+
* Focuses on critical bug fixes or security patches that maintain backward compatibility.
85+
* Examples: `0.8.1`, `0.8.2`.
86+
87+
To create a patch branch from the latest release tag:
88+
89+
```bash
90+
# Check out the base branch for the patch version
91+
git checkout pyiceberg-0.8.x
92+
93+
# Create a new branch for the upcoming patch release
94+
git checkout -b pyiceberg-0.8.1
95+
```
96+
7397
### Create Tag
7498

7599
Ensure you are on the correct branch:

0 commit comments

Comments
 (0)