Skip to content

Commit 5b37634

Browse files
committed
Release v0.6.0
1 parent cc95d48 commit 5b37634

3 files changed

Lines changed: 35 additions & 12 deletions

File tree

HOW_TO_RELEASE

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ Time required: about an hour.
1010
3. If you have any doubts, run the full test suite one final time!
1111
py.test
1212
4. On the main branch, commit the release in git:
13-
git commit -a -m 'Release v0.X.Y'
13+
git commit -a -m 'Release vX.Y.Z'
1414
5. Tag the release:
15-
git tag -a v0.X.Y -m 'v0.X.Y'
15+
git tag -a vX.Y.Z -m 'vX.Y.Z'
1616
6. Push your changes to main:
1717
git push origin main
1818
git push origin --tags
@@ -24,24 +24,41 @@ Time required: about an hour.
2424
It's OK to force push to 'stable' if necessary.
2525
We also update the stable branch with `git cherrypick` for documentation
2626
only fixes that apply the current released version.
27-
8. Add a section for the next release (v.X.(Y+1)) to doc/whats-new.rst.
28-
9. Commit your changes and push to main again:
27+
8. Build and test the release package
28+
python -m pip install --upgrade build twine
29+
rm -rf dist
30+
python -m build
31+
python -m twine check dist/*
32+
9. Add a section for the next release to doc/whats-new.rst.
33+
10. Commit your changes and push to main again:
2934
git commit -a -m 'Revert to dev version'
3035
git push origin main
3136
You're done pushing to main!
32-
10. Issue the release on GitHub. Open https://github.com/crusaderky/xarray_extras/releases;
37+
11. Issue the release on GitHub. Open https://github.com/crusaderky/xarray_extras/releases;
3338
the new release should have automatically appeared. Otherwise, click on
3439
"Draft a new release" and paste in the latest from whats-new.rst.
35-
11. Download the .tar.gz package for the release
3640
12. Use twine to register and upload the release on pypi. Be careful, you can't
3741
take this back!
38-
twine upload xarray_extras-*.tar.gz
42+
twine upload dist/*
3943
You will need to be listed as a package owner at
4044
https://pypi.python.org/pypi/xarray_extras for this to work.
4145
13. Update the docs. Login to https://readthedocs.org/projects/xarray_extras/versions/
4246
and switch your new release tag (at the bottom) from "Inactive" to "Active".
4347
It should now build automatically.
44-
14. Update conda-forge. Clone https://github.com/conda-forge/xarray-extras-feedstock
45-
and update the version number and sha256 in meta.yaml. (On OS X, you can
46-
calculate sha256 with `shasum -a 256 xarray_extras-0.X.Y.tar.gz`). Submit a pull
47-
request (and merge it, once CI passes).
48+
Make sure that both the new tagged version and 'stable' build successfully.
49+
14. Update conda-forge.
50+
14a. Clone https://github.com/conda-forge/xarray_extras-feedstock
51+
14b. Update the version number and sha256 in meta.yaml.
52+
You can calculate sha256 with
53+
sha256sum dist/*
54+
14c. Double check dependencies in meta.yaml and update them to match pyproject.toml.
55+
14d. Submit a pull request.
56+
14e. Write a comment in the PR:
57+
@conda-forge-admin, please rerender
58+
Wait for the rerender commit (it may take a few minutes).
59+
14f. Wait for CI to pass and merge.
60+
14g. The next day, test the conda-forge release
61+
conda search xarray_extras
62+
conda create -n xarray_extras-test xarray_extras
63+
conda list
64+
python -m 'import xarray_extras'

doc/whats-new.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ What's New
55

66
.. _whats-new.0.6.0:
77

8-
v0.6.0 (Unreleased)
8+
v0.6.0 (2024-03-16)
99
-------------------
1010
- Bumped minimum version of all dependencies:
1111

@@ -27,6 +27,7 @@ v0.6.0 (Unreleased)
2727
- Migrated from setup.cfg to pyproject.toml
2828
- Migrated from flake8+isort+pyupgrade to ruff
2929

30+
3031
.. _whats-new.0.5.0:
3132

3233
v0.5.0 (2021-12-01)
@@ -53,6 +54,7 @@ v0.5.0 (2021-12-01)
5354
- Use setuptools-scm for versioning
5455
- Moved the whole contents of setup.py to setup.cfg
5556

57+
5658
.. _whats-new.0.4.2:
5759

5860
v0.4.2 (2019-06-03)

pyproject.toml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ dynamic = ["version"]
3232
[project.urls]
3333
Homepage = "https://github.com/crusaderky/xarray_extras"
3434

35+
[project.readme]
36+
text = "Advanced / experimental algorithms for xarray"
37+
content-type = "text/x-rst"
38+
3539
[tool.setuptools]
3640
packages = ["xarray_extras"]
3741
zip-safe = false # https://mypy.readthedocs.io/en/latest/installed_packages.html

0 commit comments

Comments
 (0)