Skip to content

Release JITB

Joseph Harkleroad edited this page Dec 21, 2024 · 11 revisions

Release

Steps

  1. Run the test cases: python -m test
  2. Run the linters on dev
    1. pycodestyle --max-line-length=100 ./
    2. ./devops/scripts/run_pylint.sh
  3. Update CHANGELOG.md
    1. Copy empty [Unreleased] headers to the top
    2. Change old [Unreleased] to [X.Y.Z] - YYYY-MM-DD
    3. Remove empty headers from [X.Y.Z] - YYYY-MM-DD
    4. Update release links at the bottom
  4. Update pyproject.toml version
  5. Merge dev into main
  6. Build the wheel: python -m build
  7. Tag and release
    1. Click the green "Create a new release" button
    2. Click "Choose a tag" dropdown, type "vX.Y.Z" in the new tag field, and click "+ Create new tag:"
    3. Change the "Target:" dropdown to main
    4. Type "vX.Y.Z" in the "Release title" field
    5. Type a release description: "See CHANGELOG.md for release notes."
    6. Click the green "Publish release" button
    7. Click the "Attach binaries by dropping them here or selecting them." and choose the release wheel from dist

Clone this wiki locally