-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Review release process docs for PR-based releases #2499
Description
https://pypdf.readthedocs.io/en/stable/dev/releasing.html#how-is-it-done cannot be applied directly when not having direct write access to the main branch. The following comments document what I did and observed:
-
Run
python make_release.py -
Adapt the three generated files. For version 4.1.0, DEV: Fix changelog generator regarding whitespace and handling of "Other" group #2492 had to be mitigated.
-
Create new branch:
git checkout -b release_4.1.0 -
Commit the changes:
git commit --file RELEASE_COMMIT_MSG.md(Do not use the-eparameter here - this will open the editor and might strip the headings due to the lines starting with#being interpreted as comments.) -
Verify the commit message:
git log -
Create PR and ask for review
-
The PR title check is failing - needs some adjustments
-
Merge the PR, ensuring that the title only is
REL: 4.1.0and the body contains the correct message. -
git checkout main && git pull -
Create the tag:
git tag 4.1.0 --file RELEASE_TAG_MSG.md(No-sdue to not signing it.) -
Verify the tag message:
git show 4.1.0- In my case, I needed
git config core.commentChar ";"before creating the tag, as otherwise the#lines would disappear again ... - Delete a wrong tag:
git tag -d 4.1.0
- In my case, I needed
-
Push the tag:
git push --tags- Permissions not sufficient -
CI should do the remaining steps of creating the release and uploading the release to PyPI