The new optimize module was missing in the 1.0 release, which means that the PyPi version of record is broken. This didn't show up in the tests because all the tests are run using the local files (the installed package is not actually used).
We should fix the way the test suite works on GitHub, but in the meantime a critical fix is needed. Release 1.0.1 is quick on the heels of 1.0...
Steps for me:
[x] Check new version can be used non-locally (python -m pip install ., then run from another directory)
[x] Open zenodo, start new version, reserve DOI (currently at the top of Basic Information)
[x] New branch (burnman-Major.Minor)
[x] Bump version number in new branch (in burnman/version.py)
[x] Update changelog.txt with major changes since the last release.
[x] Update setup.py (if necessary, probably only Python versions need checking (as we've checked the installation works above), but might be worth checking that sudo python setup.py sdist bdist_wheel works without errors)
[x] Update new link to the zenodo version (using the new reserved DOI) in burnman/init.py
[x] Update new link to the zenodo version (using the new reserved DOI) in docs/index.rst
[x] Update new badge link to zenodo (using the new reserved DOI) in Readme.md
[x] Push new branch to Github upstream burnman-Major.Minor (not master)
[x] Make release on Github using upstream burnman-Major.Minor branch
[x] Make release commit (tag, not branch) active on readthedocs (you'll need to build from master first so that ReadTheDocs finds the new release tag)
[x] Build documentation on readthedocs
[x] Download zip file
[x] Upload new zip file to zenodo, fill in details on website (including new link to ReadTheDocs)
[x] Save and publish in zenodo
[x] Update GitHub release with new zip files and link to the ReadTheDocs documentation
[x] Push release to Pypi (from clean directory):
1) sudo python setup.py sdist bdist_wheel (sudo unfortunately required)
2) twine check dist/ (to check zip and wheel)
3) twine upload --repository-url https://test.pypi.org/legacy/ dist/ (to test upload, can get password from the pypi website)
4) twine upload dist/* (the final upload to Pypi)
[x] Merge upstream burnman-Major.Minor branch to master
[x] Bump version numbers in version.py on upstream master
version=[Major].[Minor+1].0pre
short_version=[Major].[Minor+1].0
[x] Check and update homepage (especially the downloads section and the zenodo links)
The new optimize module was missing in the 1.0 release, which means that the PyPi version of record is broken. This didn't show up in the tests because all the tests are run using the local files (the installed package is not actually used).
We should fix the way the test suite works on GitHub, but in the meantime a critical fix is needed. Release 1.0.1 is quick on the heels of 1.0...
Steps for me:
python -m pip install .
, then run from another directory)sudo python setup.py sdist bdist_wheel
works without errors)