Skip to content

Latest commit

 

History

History
20 lines (18 loc) · 1.69 KB

cutting-a-release.md

File metadata and controls

20 lines (18 loc) · 1.69 KB

Cutting a Release

For maintainers, here are the basic steps when creating a new release of mistletoe.

  • set a release version & commit chore: version <x.y.z>
  • publish artifacts of the release
    • official documentation: Packaging Python Projects
    • install / upgrade the build tool: $ python -m pip install --upgrade build
    • make sure there are no old relicts in the local "dist" folder
    • build the Wheel artifact ("dist/*.whl"): $ python -m build
    • upload the distribution archives to PyPi:
      • install / upgrade Twine: $ python -m pip install --upgrade twine
      • if unsure, upload to test PyPi and/or test locally - see docs
      • do the upload to PyPi: $ python -m twine upload dist/*
        • authenticate with your token from PyPi (for details, see docs again)
      • check that you can install locally what you uploaded: $ python -m pip install mistletoe
  • create the release in GitHub
    • attach the "dist/*.whl" from the previous step to the release (drag & drop) (source code archives are attached automatically)
    • publish the release, let GitHub create a new Git tag automatically
  • commit chore: next dev version