Skip to content

Latest commit

 

History

History
38 lines (27 loc) · 1.39 KB

RELEASING.md

File metadata and controls

38 lines (27 loc) · 1.39 KB
Raw

Releasing Pyorbital

  1. checkout main branch
  2. pull from repo
  3. run the unittests
  4. run loghub and update the CHANGELOG.md file:
loghub pytroll/pyorbital --token $LOGHUB_GITHUB_TOKEN -st $(git tag --sort=-version:refname --list 'v*' | head -n 1) -plg bug "Bugs fixed" -plg enhancement "Features added" -plg documentation "Documentation changes"

This uses a LOGHUB_GITHUB_TOKEN environment variable. This must be created on GitHub and it is recommended that you add it to your .bashrc or .bash_profile or equivalent. See https://github.com/settings/tokens for details on GitHub tokens.

Don't forget to commit!

  1. Create a tag with the new version number, starting with a 'v', eg:
git tag -a v0.22.45 -m "Version 0.22.45"

See semver.org on how to write a version number.

  1. push changes to github git push --follow-tags

  2. Verify github action unittests passed.

  3. Create a "Release" on GitHub by going to https://github.com/pytroll/pyorbital/releases and clicking "Draft a new release". On the next page enter the newly created tag in the "Tag version" field, "Version X.Y.Z" in the "Release title" field, and paste the markdown from the changelog (the portion under the version section header) in the "Describe this release" box. Finally click "Publish release".

  4. Verify the GitHub actions for deployment succeed and the release is on PyPI.