-
-
Notifications
You must be signed in to change notification settings - Fork 9
Update "Release process" docs #153
Copy link
Copy link
Open
Labels
CI/CDRelated to the CI/CD processRelated to the CI/CD processDOCSImprovements or additions to documentationImprovements or additions to documentationP:3Priority 3Priority 3
Description
Metadata
Metadata
Assignees
Labels
CI/CDRelated to the CI/CD processRelated to the CI/CD processDOCSImprovements or additions to documentationImprovements or additions to documentationP:3Priority 3Priority 3
Update the "Release process" docs to reflect the current status.
Maybe refactor steps 3. and 4. in a separate script in
cicd_utils/and call it from here. The script should ask for user confirmation before proceeding. To avoid accidental releases, maybe require the user to type out the exact version to be released (you can include the version in the script's output so the user can copy-paste it). The script to validate that the user is running the script from the correct cwd, git branch (main), set theSKIP='no-commit-to-branch'environment variable to skip the pre-commit hook that doesn't allow commits to themainbranch, and finally, run thebumpversion <major|minor|patch>command. Maybe ask for confirmation to push all changes and new tags to the remote repository or to revert all changes and tags if the user decides to cancel the release?Potentially relevant references:
https://github.com/python-pillow/Pillow/blob/109c6bf6c0abc00c37b0819ebd573390647692e4/pyproject.toml#L89C7-L94https://github.com/pypa/cibuildwheel/blob/main/examples/github-deploy.ymlhttps://cibuildwheel.readthedocs.io/en/stable/