ridgeplot icon indicating copy to clipboard operation
ridgeplot copied to clipboard

Update "Release process" docs

Open tpvasconcelos opened this issue 1 year ago • 2 comments

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 the SKIP='no-commit-to-branch' environment variable to skip the pre-commit hook that doesn't allow commits to the main branch, and finally, run the bumpversion <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/pypa/gh-action-pypi-publish
  • https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
  • ~https://github.com/python-pillow/Pillow/blob/109c6bf6c0abc00c37b0819ebd573390647692e4/pyproject.toml#L89C7-L94~
  • ~https://github.com/pypa/cibuildwheel/blob/main/examples/github-deploy.yml~
  • ~https://cibuildwheel.readthedocs.io/en/stable/~

tpvasconcelos avatar Dec 30 '23 19:12 tpvasconcelos

here's sktime's, in case it would be helpful:

https://www.sktime.net/en/stable/developer_guide/release.html

fkiraly avatar Feb 10 '24 19:02 fkiraly

Great reference! Thanks @fkiraly

tpvasconcelos avatar Feb 10 '24 23:02 tpvasconcelos