Skip to content

Latest commit

 

History

History
68 lines (53 loc) · 2.19 KB

RELEASE.md

File metadata and controls

68 lines (53 loc) · 2.19 KB
Raw

How to make a release

ldapauthenticator is a package available on PyPI and conda-forge. These are instructions on how to make a release on PyPI. The PyPI release is done automatically by TravisCI when a tag is pushed.

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

Steps to make a release

  1. Checkout master 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 master
git fetch $ORIGIN master
git reset --hard $ORIGIN/master
# WARNING! This next command deletes any untracked files in the repo
git clean -xfd

  2. Set the version variable in setup.py appropriately and make a commit.

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

  3. Reset the version variable 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"

  4. Push your two commits to master.

    # first push commits without a tags to ensure the
# commits comes through, because a tag can otherwise
# be pushed all alone without company of rejected
# commits, and we want have our tagged release coupled
# with a specific commit in master
git push $ORIGIN master

  5. Create a git tag for the pushed release commit and push it.

    git tag -a $VERSION -m $VERSION HEAD~1

# then verify you tagged the right commit
git log

# then push it
git push $ORIGIN refs/tags/$VERSION

  6. Following the release to PyPI, an automated PR should arrive to conda-forge/ldapauthenticator-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.