We follow semantic versioning, e.g., v1.0.0. A major version causes incompatible API changes, a minor version adds functionality, and a patch covers bug fixes.
- Create a new branch
release-vX.x.xwith the version for the release.
- Update CHANGELOG.rst
- Make sure all new changes, features are reflected in the documentation.
Open a new pull request for this branch targeting master
After all tests pass and the PR has been approved, merge the PR into
Tag a release and push to github:
$ git tag -a v1.0.0 -m "Version 1.0.0" $ git push origin master --tags
Build and publish release on PyPI:
$ git clean -xfd # remove any files not checked into git $ python setup.py sdist bdist_wheel --universal # build package $ twine upload dist/* # register and push to pypi
Update the stable branch (used by ReadTheDocs):
$ git checkout stable $ git rebase master $ git push -f origin stable $ git checkout master
Go to https://readthedocs.org and add the new version to “Active Versions” under the version tab. Force-build “stable” if it isn’t already building.
Update climpred conda-forge feedstock
Clone this fork and edit recipe:$ git clone email@example.com:username/climpred-feedstock.git $ cd climpred-feedstock $ cd recipe $ # edit meta.yaml
- Update version
- Get sha256 from pypi.org for climpred
- Check that
requirements.txtfrom the main
climpredrepo is accounted for in
meta.yamlfrom the feedstock.
- Fill in the rest of information as described here
- Commit and submit a PR