Skip to content

Release

Jump to bottom
Benjamin Bossan edited this page Sep 4, 2023 · 14 revisions

How to create a new release of skorch

  1. check project board for new release: everything done?
  2. create a new branch (release-X.Y.Z)
  3. change VERSION to new version
  4. update CHANGES.md
    1. rename UNRELEASED section to new version
    2. create new UNRELEASED section
    3. update links at the bottom of CHANGES.md
  5. use git grep TODO to find and fix deprecations for the new version
  6. commit any changes
  7. write a nice summary with the highlights of the current release
  8. push changes
  9. create PR
  10. challenge, then merge PR -- add the summary to the commit message
  11. ensure that current state of master is fetched
  12. run PYTORCH_VERSION=1.8.1 ./scripts/deploy.sh stage (use a recent pytorch version)
  13. verify test results and package on pypi testing
  14. run PYTORCH_VERSION=1.8.1 ./scripts/deploy.sh live (use a recent pytorch version)
  15. verify test results and package on pypi
  16. create v<VERSION> tag using github release tool and add the summary
  17. after the release, update the VERSION again, this time to the next higher patch version + dev (e.g. 0.9.0 -> 0.9.1dev)
  18. check that a new stable build of the docs was triggered on readthedocs
  19. release on conda-forge by merging automatically created PR (requires access, so ping BenjaminBossan or, if not available, dhirschfeld)

Clone this wiki locally