Skip to content

RELEASE_PROCESS.rst

Latest commit

 

History

History
53 lines (51 loc) · 2.74 KB

RELEASE_PROCESS.rst

File metadata and controls

53 lines (51 loc) · 2.74 KB
Raw

Release Process

This document describes the steps needed to publish a new release of ESA.

  1. (Optional) If any updates has been made to the _performance.py then you need to compile the module first by running compile_for_all_versions.py.
  2. Ensure you have checked out the develop branch and have a clean repository (no local changes, new files, etc.).
  3. Run all tests for all Python versions (3.7 - 3.10) by running the script tests\run_tests_for_all_python_versions.py or manually run all tests in all Python environments by running the following from the top level of the repository after activating each virtual environment: python -m unittest discover tests.
  4. Assess testing coverage by running docs\rst\coverage_to_rst.py.
  5. Check the top-level README file - if testing coverage is NOT at 100%, we need to add tests to get it there before proceeding. Add the tests, and start over.
  6. Update VERSION file (careful not to add a newline at the end).
  7. Update docs\rst\welcome\changelog.rst. Add detailed notes related to what has changed in this release. This should include new functions/features added, bugs fixed, and any changes that break backwards compatibility (ideally, there should not be any breaking changes).
  8. Install esa locally into your virtual environment that you plan to use for building the documentation (see next step) by executing python -m pip install -e .[test,doc]. Note the -e specifies "editable" mode so that the installation process does not copy all the files into your virtual environment's Lib\site-packages directory. This local, editable installation will automatically update __version__ in __init__.py.
  9. If all tests were successful, build the documentation (see README in docs\rst directory). Note that there should NOT be ANY warnings or errors in the console output when building the documentation.
  10. When ready, commit all the new changes to the develop branch.
  11. Checkout the master branch, and run git merge develop
  12. After merging, add a version tag like so: git tag -a v1.0.1 -m "ESA version 1.0.1"
  13. Run git push
  14. Run git push --tags
  15. Ensure setuptools and wheel are up to date: python -m pip install --upgrade setuptools wheel
  16. Generate the distribution archive by running this command from the same directory where setup.py is located: python setup.py sdist bdist_wheel
  17. Upload the distribution archive to the Python Package Index by running this command: python -m twine upload dist/*. Before uploading make sure there is only one archive version in the dist directory.