cf-xarray
cf-xarray copied to clipboard
Add release instructions
- Update
whats-new
andCITATION.cff
- Create a new section with date in
whats-new.rst
- Add entries in the section looking at recent commits.
- Create a PR to update whats-new.
- Add version info and release date at bottom of CITATION.cff
- Add the
test-build
tag. - Make sure tests pass.
- Merge the PR.
- Create a new section with date in
- Tag a release using the Github UI
- Click "Draft a new release"
- Add a new tag
vX.Y.Z
- Use
vX.Y.Z
as name - Generate release notes, and edit to make it understandable to Github users.
- Create the release!
- After the tag is created, a Github Action to deploy to pypi will be triggered. Monitor to make sure this succeeds (click "Actions")
- Wait for the conda-forge PR to show up and merge that after checking that requirements have been updated.
@kthyng you should have rights to create a release. Let's try it out!
Please add a whats-new note for #397
Do you want me to add this as a docs page?
Sure could go under "Contributing Guide", but let's make sure its comprehensive first.
The recent releases don't really have anything in the release description. Should I just copy in the stuff from "What's New"?
That's annoying because it's in rst
while github expects markdown. Click thee "Generate release notes" button and edit what it gives you.
Github is surfacing these things in the UI now so it's nice to add.
Um this is super awesome! I just clicked through and I see this, which looks very thorough:
![image](https://user-images.githubusercontent.com/3487237/215858926-f20d1300-3199-48a4-838f-b21403603e9e.png)
but when I look at the releases on github I see the following which doesn't really show anything for the past few releases:
![image](https://user-images.githubusercontent.com/3487237/215859105-5b2f5785-f341-4fc5-8387-fe0ba2d3903b.png)
Am I missing something?
What you have is nice. Let's go with that. You could remove things that seem like trivial maintenance things, but it's not necessary
I think I was being lazy for the last ones.
:clap: :clap: that worked well! https://pypi.org/project/cf-xarray/
I think your instructions were good!