Skip to content

Latest commit

 

History

History
70 lines (51 loc) · 2.26 KB

RELEASE.md

File metadata and controls

70 lines (51 loc) · 2.26 KB

How to make a release

gh-scoped-creds is a package available on PyPI and on conda-forge.

These are instructions on how to make a release on PyPI. The PyPI release is done automatically by CI when a git tag is pushed. Following a PyPI release is made, a pull request will be opened to the conda-forge feedstock.

For you to follow along according to these instructions, you need:

Steps to make a release

  1. Make sure CHANGELOG.md is up-to-date ahead of time with a dedicated changelog PR. github-activity can help with this.

  2. Checkout main and make sure it is up to date.

    ORIGIN=${ORIGIN:-origin} # set to the canonical remote, e.g. 'upstream' if 'origin' is not the official repo
git checkout main
git fetch $ORIGIN main
git reset --hard $ORIGIN/main
# WARNING! This next command deletes any untracked files in the repo
git clean -xfd

  3. Set the version field in setup.py appropriately and make a commit.

    git add setup.py
VERSION=...  # e.g. 1.2.3
git commit -m "release $VERSION"
git tag -a $VERSION -m $VERSION HEAD

  4. Reset the version field in setup.py appropriately with an incremented patch version and a dev element, then make a commit.

    git add setup.py
git commit -m "back to dev"

  5. Verify your git history looks good.

    git log

  6. Push the commits and git tags.

    git push --atomic --follow-tags $ORIGIN main

  7. Verify that the GitHub workflow triggers and succeeds, and that that the PyPI project received a new release.

  8. Following the release to PyPI, an automated PR should arrive to conda-forge/gh-scoped-creds-feedstock, check for the tests to succeed on this PR and then merge it to successfully update the package for conda on the conda-forge channel.