Skip to content

Latest commit

 

History

History
159 lines (139 loc) · 5.25 KB

HOW_TO_RELEASE.md

File metadata and controls

159 lines (139 loc) · 5.25 KB
Raw

How to issue an xarray release in 20 easy steps

Time required: about an hour.

These instructions assume that upstream refers to the main repository:

$ git remote -v
{...}
upstream        https://github.com/pydata/xarray (fetch)
upstream        https://github.com/pydata/xarray (push)

  1. Ensure your master branch is synced to upstream:

    git switch master
git pull upstream master

  2. Confirm there are no commits on stable that are not yet merged (ref):

    git merge upstream stable

  3. Add a list of contributors with:

    git log "$(git tag --sort="v:refname" | sed -n 'x;$p').." --format=%aN | sort -u | perl -pe 's/\n/$1, /'

    or by substituting the previous release in {0.X.Y-1}:

    git log v{0.X.Y-1}.. --format=%aN | sort -u | perl -pe 's/\n/$1, /'

    This will return the number of contributors:

    git log v{0.X.Y-1}.. --format=%aN | sort -u | wc -l

  4. Write a release summary: ~50 words describing the high level features. This will be used in the release emails, tweets, GitHub release notes, etc.

  5. Look over whats-new.rst and the docs. Make sure "What's New" is complete (check the date!) and add the release summary at the top. Things to watch out for:

    • Important new features should be highlighted towards the top.
    • Function/method references should include links to the API docs.
    • Sometimes notes get added in the wrong section of whats-new, typically due to a bad merge. Check for these before a release by using git diff, e.g., git diff v{0.X.Y-1} whats-new.rst where {0.X.Y-1} is the previous release.

  6. If possible, open a PR with the release summary and whatsnew changes.

  7. After merging, again ensure your master branch is synced to upstream:

    git pull upstream master

  8. If you have any doubts, run the full test suite one final time!

    pytest

  9. Check that the ReadTheDocs build is passing.

  10. On the master branch, commit the release in git:

    git commit -am 'Release v{0.X.Y}'

  11. Tag the release:

    git tag -a v{0.X.Y} -m 'v{0.X.Y}'

  12. Build source and binary wheels for PyPI:

    git clean -xdf  # this deletes all uncommitted changes!
python setup.py bdist_wheel sdist

  13. Use twine to check the package build:

    twine check dist/xarray-{0.X.Y}*

  14. Use twine to register and upload the release on PyPI. Be careful, you can't take this back!

    twine upload dist/xarray-{0.X.Y}*

    You will need to be listed as a package owner at https://pypi.python.org/pypi/xarray for this to work.

  15. Push your changes to master:

    git push upstream master
git push upstream --tags

  16. Update the stable branch (used by ReadTheDocs) and switch back to master:

     git switch stable
 git rebase master
 git push --force upstream stable
 git switch master

    It's OK to force push to stable if necessary. (We also update the stable branch with git cherry-pick for documentation only fixes that apply the current released version.)

  17. Add a section for the next release {0.X.Y+1} to doc/whats-new.rst:

    .. _whats-new.{0.X.Y+1}:

v{0.X.Y+1} (unreleased)
---------------------

Breaking changes
~~~~~~~~~~~~~~~~


New Features
~~~~~~~~~~~~


Bug fixes
~~~~~~~~~


Documentation
~~~~~~~~~~~~~


Internal Changes
~~~~~~~~~~~~~~~~

  18. Commit your changes and push to master again:

    git commit -am 'New whatsnew section'
git push upstream master

    You're done pushing to master!

  19. Issue the release on GitHub. Click on "Draft a new release" at https://github.com/pydata/xarray/releases. Type in the version number and paste the release summary in the notes.

  20. Update the docs. Login to https://readthedocs.org/projects/xray/versions/ and switch your new release tag (at the bottom) from "Inactive" to "Active". It should now build automatically.

  21. Issue the release announcement to mailing lists & Twitter. For bug fix releases, I usually only email [email protected]. For major/feature releases, I will email a broader list (no more than once every 3-6 months):

    Google search will turn up examples of prior release announcements (look for "ANN xarray").

Note on version numbering

We follow a rough approximation of semantic version. Only major releases (0.X.0) should include breaking changes. Minor releases (0.X.Y) are for bug fixes and backwards compatible new features, but if a sufficient number of new features have arrived we will issue a major release even if there are no compatibility breaks.

Once the project reaches a sufficient level of maturity for a 1.0.0 release, we intend to follow semantic versioning more strictly.