Skip to content

Commit 09e0c62

Browse files
committed
update contributing notes, bump version to 0.3.1
1 parent 346595b commit 09e0c62

File tree

3 files changed

+32
-11
lines changed

3 files changed

+32
-11
lines changed

HISTORY.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# History
22

3+
## 0.3.1
4+
5+
Maintenance release.
6+
* min python version is now 3.10
7+
* update notes on deployment
8+
39
## 0.3.0
410

511
### New Features

docs/contributing.rst

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -86,11 +86,6 @@ Now you can make your changes locally.
8686

8787
$ pytest
8888

89-
To test multiple python versions, you can use `tox`::
90-
91-
$ tox
92-
93-
9489
7. Commit your changes and push your branch to GitHub::
9590

9691

@@ -130,11 +125,31 @@ Deploying
130125
#########
131126

132127
A reminder for the maintainers on how to deploy.
133-
Make sure all your changes are committed (including an entry in HISTORY.md). Then::
134128

129+
First, make sure that:
130+
131+
* all your changes are committed (including an entry in HISTORY.md).
132+
* the version in `yt_xarray/__init__.py` matches the version you are releasing.
133+
134+
Then, double check your `main` branch mactches upstream (assuming that `git remote -v` lists
135+
`[email protected]:data-exp-lab/yt_xarray.git` as the upstream repo)::
136+
137+
$ git fetch --all
138+
$ git checkout main
139+
$ git rebase upstream/main
140+
141+
And then create a tag for your new release. For example, if you are releasing
142+
version `1.1.2`::
143+
144+
145+
$ git tav v1.1.2
146+
147+
Now push that tag to the upstream repo::
135148

136-
$ bump2version patch # possible: major / minor / patch
137-
$ git push
138-
$ git push --tags
149+
$ git push upstream v1.1.2
139150

140-
github will then push to PyPI if tests pass.
151+
This will trigger a number of automated Github actions that include an
152+
automated push to PyPI (if tests pass) and the creation of a draft release
153+
on Github. Wait for the push to PyPI to finish then go edit the draft release
154+
that should be visible at https://github.com/data-exp-lab/yt_xarray/releases and
155+
hit publish after editing release notes.

yt_xarray/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
__author__ = """Chris Havlin"""
44
__email__ = "[email protected]"
5-
__version__ = "0.3.0.dev"
5+
__version__ = "0.3.1"
66

77

88
# import the xarray accessor so it is registered with xarray

0 commit comments

Comments
 (0)