Skip to content

Latest commit

 

History

History
59 lines (45 loc) · 1.71 KB

RELEASING.md

File metadata and controls

59 lines (45 loc) · 1.71 KB
Raw

Creating a new release

This document is only relevant for maintainers of openPMD-viewer. It explains how to create a new release. In future versions of this packages, some of the steps below will be automatized.

Preparing your environment for a release

Make sure that your local environment is ready for a full release on PyPI and conda. In particular:

  • you should install the package twine.
  • you should have a registered account on PyPI and test PyPI, and your $HOME should contain a file .pypirc which contains the following text:
[distutils]
index-servers=
   pypitest
   pypi

[pypitest]
repository = https://testpypi.python.org/pypi
username = <yourPypiUsername>

[pypi]
repository = https://pypi.python.org/pypi
username = <yourPypiUsername>

Creating a release on Github

  • Make sure that the version number in openpmd_viewer/__version__.py correspond to the new release, and that the corresponding changes have been documented in CHANGELOG.md.

  • If everything works fine, then merge the dev version into main and upload it to Github:

git checkout main
git merge dev
git push
  • Create a new release through the graphical interface on Github

Uploading the package to PyPI

  • Upload the package to PyPI:
rm -rf dist
python setup.py sdist bdist_wheel
twine upload dist/* -r pypi

(NB: You can also first test this by uploading the package to test PyPI ; to do so, simply replace pypi by pypitest in the above set of commands)