python-package-guide icon indicating copy to clipboard operation
python-package-guide copied to clipboard

Add: TUTORIAL on dynamic / version control based versioning to the packaging guide

Open lwasser opened this issue 3 years ago • 1 comments

Let's create a tutorial on dynamic versioning in our package guide that covers using hatch_vcs for versioning

the tutorial would cover

  • what is dynamic versioning?
  • How to create github tags / releases
  • How to setup hatch to use dynamic versioning (hatch_vcs)
  • How to create a github action that triggers a release to PyPI when a new tagged release is created

Other topics for a future issue to consider

  • Where you want to trigger the tag update -
    • local on your computer create a tag and then a release
    • Using a Github action and a release online (our github.com/pyopensci/pyospackage repo uses the github action approach)
  • How you want to maintain the changelog and bump versions while keeping it up to date.

lwasser avatar Nov 07 '22 20:11 lwasser

Make sure this comment is in the package guide with more detail. https://github.com/pyOpenSci/peer-review-guide/pull/148/files#r1049888878

lwasser avatar Dec 15 '22 16:12 lwasser