Skip to content

RELEASING.rst

Latest commit

 

History

History
52 lines (42 loc) · 2.7 KB

RELEASING.rst

File metadata and controls

52 lines (42 loc) · 2.7 KB

Releasing pycalphad-xml

Create a release of pycalphad-xml

To release a new version of pycalphad-xml:

These steps assume that 0.1 is the most recently tagged version number and 0.2 is the next version number to be released. Replace their values with the last public release's version number and the new version number as appropriate.

  1. Determine what the next version number should be using semantic versioning.
  2. Resolve or defer all pull requests and issues tagged with the upcoming version milestone.
  3. git stash to save any uncommitted work.
  4. git checkout main
  5. git pull to make sure you haven't missed any last-minute commits. After this point, nothing else is making it into this version.
  6. pytest to ensure that all tests pass locally.
  7. Update CHANGES.rst with a human-readable list of changes since the last commit. git log --oneline --no-decorate --color 0.1^..main can be used to list the changes since the last version.
  8. git add CHANGES.rst to stage the updated documentation.
  9. git commit -m "REL: 0.2" to commit the changes.
  10. git push origin main
  11. Verify that all continuous integration test and build workflows pass.
  12. Create a release on GitHub
    1. Go to https://github.com/pycalphad/pycalphad-xml/releases/new
    2. Set the "Tag version" field to 0.2.
    3. Set the branch target to main.
    4. Set the "Release title" to pycalphad-xml 0.2.
    5. Leave the description box blank.
    6. If this version is a pre-release, check the "This is a pre-release" box.
    7. Click "Publish release".
  13. The new version will be available on PyPI when the Build and deploy to PyPI workflow on GitHub Actions finishes successfully.

Deploy to PyPI (manually)

Warning

DO NOT FOLLOW THESE STEPS unless the GitHub Actions deployment workflow is broken. Creating a GitHub release should trigger the Build and deploy to PyPI workflow on GitHub Actions that will upload source and platform-dependent wheel distributions automatically.

To release a source distribution to PyPI:

  1. If deploying for the first time: pip install twine build
  2. rm -R dist/* on Linux/OSX or del dist/* on Windows
  3. git checkout main to checkout the latest version
  4. git pull
  5. git log to verify the repository state matches the newly created tag
  6. python -m build --sdist
  7. Make sure that the script correctly detected the new version exactly and not a dirty / revised state of the repo.
  8. twine upload dist/* to upload (assumes a correctly configured ~/.pypirc file)