Skip to content

Creating a new release (GitHub and PyPi)

Kent Inverarity edited this page May 12, 2022 · 11 revisions
  1. Ensure you are on master: $ git checkout master
  2. Ensure you are using the latest copy of master: $ git pull origin master
  3. Check for any local changes to master: $ git status - test locally and push if necessary.
  4. Check that GitHub Actions Python CI for master is passing.
  5. Find changes since last version release: see list of commits.
  6. Summarise these changes in docs/source/changelog.rst
  7. Run the Jupyter Noteook at docs/Add links to GitHub for all issue and PR refs in changelog.ipynb to add hyperlinks for all issue and PR references.
  8. Commit with a message e.g. Release v1.3
  9. Tag with the same message e.g. git tag v1.3
  10. Push to github - first the commit: git push origin master
  11. ..and then push the new tag: git push origin tag v1.3
  12. Create a universal wheel: python setup.py bdist_wheel --universal
  13. This will put a new wheel file in dist/
  14. Also create a source distribution: python setup.py sdist
  15. This will put a source distribution archive in dist/
  16. Upload all the new distribution release files (wheel and archive) to PyPI: twine upload -u USERNAME -p PASSWORD dist/file
  17. Create a new GitHub release - https://github.com/kinverarity1/lasio/releases/new - select the tag
  18. Copy the CHANGELOG text in - convert to RST to Markdown quickly by replacing `# with # and `_ with .
  19. Copy the wheel and source distribution archive files into the release page.
  20. Publish the release.

That's it.

Clone this wiki locally