intake / intake-xarray

Intake plugin for xarray
https://intake-xarray.readthedocs.io/
BSD 2-Clause "Simplified" License
74 stars 36 forks source link

Document release process (and cut 0.4.1) #95

Closed scottyhq closed 3 years ago

scottyhq commented 3 years ago

It would be great to get a new release (0.4.1) out. @martindurant - I'd be happy to add a small section in the docs regarding your preferred way to do this.

Or we could add a "publish" github action to push to pypi as we're doing in intake-stac that just requires pushing a new tag. A changelog would also be nice to add.

martindurant commented 3 years ago

we could add a "publish" github action to push to pypi

Sounds like a good plan! I have still to get around to doing any GHaction myself.

The changelog could be generated from PR titles for now.

weiji14 commented 3 years ago

Gentle nudge to see if we could we get a v0.4.1 tag for intake-xarray :slightly_smiling_face:

P.S. Happy to help out with repo maintainence if people have too much on their plate!

scottyhq commented 3 years ago

right, thanks @weiji14 i've been a bit busy lately and would be happy if you released a new version! Note that it's probably worth sorting this issue out and adding a test for the many file case https://github.com/intake/intake-xarray/issues/94#issuecomment-738883524

weiji14 commented 3 years ago

Cool, I haven't got permissions on this repo but happy to get added to the team/organization here (and on PyPI?) to see what I can do for the release. The changelog actually said the release was on 2020-12-03, should we update that?

The issue at #94 seems a bit complicated to write a test case for, and I'd suggest solving that in v0.4.2.

scottyhq commented 3 years ago

should we update that? yep ;)

Seems that I can't change repo permissions settings, @martindurant are you the only one currently with those permissions?

martindurant commented 3 years ago

I thought you could too @scottyhq , at a maintainer. I don't see a higher level of permissions. In any case, I have invited @weiji14 to that level too.

I'll add you both to pypi - do you both have the same usernames as on github?

scottyhq commented 3 years ago

I'll add you both to pypi - do you both have the same usernames as on github?

yes for me

weiji14 commented 3 years ago

Yep, I have the same username on PyPI.

martindurant commented 3 years ago

You are both added as maintainers on pypi

weiji14 commented 3 years ago

Great, I'll push a v0.4.1 tag and the PyPI publish workflow at https://github.com/intake/intake-xarray/blob/31cb241f5cc74b01bd5d399b0d8fc695acf4063a/.github/workflows/pypipublish.yaml should work :crossed_fingers:.

weiji14 commented 3 years ago

Hmm, looking at https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#release, I think we need to change this line to use 'published' instead of 'created':

https://github.com/intake/intake-xarray/blob/31cb241f5cc74b01bd5d399b0d8fc695acf4063a/.github/workflows/pypipublish.yaml#L3-L5

martindurant commented 3 years ago

Feel free to use twine locally too... I have never bothered to click the "release" button in github anyway

weiji14 commented 3 years ago

Haven't used twine before :joy:, I'll change the GitHub Actions workflow file and re-publish a new v0.4.1 release. Edit: done at 227c675c5722cbdc7f727ae6db622455b2f49e1f

martindurant commented 3 years ago

OK, whatever works for you!

weiji14 commented 3 years ago

Ok, v0.4.1 is on PyPI at https://pypi.org/project/intake-xarray/0.4.1/ :smile:

martindurant commented 3 years ago

I'll merge the subsequent conda-forge PR when it comes through.

weiji14 commented 3 years ago

Cool, happy to be added as a maintainer on https://github.com/conda-forge/intake-xarray-feedstock too :slightly_smiling_face:

martindurant commented 3 years ago

I think the easiest way is to make a PR adding you to the list of maintainers in the meta file