Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Major release (1.0.0) #388

Closed
34 tasks done
bobmyhill opened this issue Aug 1, 2021 · 1 comment
Closed
34 tasks done

Major release (1.0.0) #388

bobmyhill opened this issue Aug 1, 2021 · 1 comment
Milestone

Comments

@bobmyhill
Copy link
Member

bobmyhill commented Aug 1, 2021

As a companion to the new paper, we should make another major release. In this release, we should add the following:

Final steps once we have the code ready:

  • Open zenodo, start new version, reserve DOI (currently at the top of Basic Information)
  • New branch (burnman-Major.Minor)
  • Bump version number in new branch (in burnman/version.py)
  • Update changelog.txt with major changes since the last release.
  • Update setup.py (if necessary, probably only Python versions need checking, but might be worth checking that sudo python setup.py sdist bdist_wheel works without errors)
  • Update new link to the zenodo version (using the new reserved DOI) in burnman/init.py
  • Update new link to the zenodo version (using the new reserved DOI) in docs/index.rst
  • Update new badge link to zenodo (using the new reserved DOI) in Readme.md
  • Push new branch to Github upstream burnman-Major.Minor (not master)
  • Make release on Github using upstream burnman-Major.Minor branch
  • 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)
  • Build documentation on readthedocs
  • Download zip file
  • Upload new zip file to zenodo, fill in details on website (including new link to ReadTheDocs)
  • Save and publish in zenodo
  • Update GitHub release with new zip files and link to the ReadTheDocs documentation
  • 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)
  • Merge upstream burnman-Major.Minor branch to master
  • Bump version numbers in version.py on upstream master
  • version=[Major].[Minor+1].0pre
  • short_version=[Major].[Minor+1].0
  • Check and update homepage (especially the downloads section and the zenodo links)
@bobmyhill bobmyhill mentioned this issue Aug 1, 2021
6 tasks
@bobmyhill bobmyhill added this to the 1.0.0 milestone Aug 1, 2021
@bobmyhill
Copy link
Member Author

BurnMan 1.0 has now been released! https://pypi.org/project/burnman/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant