Skip to content

Releasing Instructions

Adam J. Stewart edited this page Feb 2, 2021 · 11 revisions

Below are a list of instructions for creating a new release of fiscalyear. Fiscalyear uses semantic versioning for its version numbering.

Updating the Code

  1. Make sure all tests pass, and we have 100% coverage
  2. Change the __version__ in fiscalyear.py
  3. Update list of tested Python versions in .github/workflows/pytest.yaml
  4. Update list of supported Python versions in setup.py

Releasing on GitHub

Follow the instructions at https://help.github.com/en/github/administering-a-repository/creating-releases

Releasing on PyPI

Follow the instructions at https://packaging.python.org/tutorials/packaging-projects/

  1. python setup.py sdist --formats=gztar,zip to build .tar.gz and .zip
  2. python3 setup.py bdist_wheel to build wheel for Python 3
  3. python2 setup.py bdist_wheel to build wheel for Python 2
  4. Check fiscalyear.egg-info/SOURCES.txt and make sure all important files are included
  5. twine upload dist/*

Releasing on Conda

Submit a PR to https://github.com/conda-forge/fiscalyear-feedstock

Releasing on Spack

Submit a PR to https://github.com/spack/spack

Clone this wiki locally