cf-xarray icon indicating copy to clipboard operation
cf-xarray copied to clipboard

Add release instructions

Open dcherian opened this issue 1 year ago • 9 comments

  1. Update whats-new and CITATION.cff
    1. Create a new section with date in whats-new.rst
    2. Add entries in the section looking at recent commits.
    3. Create a PR to update whats-new.
    4. Add version info and release date at bottom of CITATION.cff
    5. Add the test-build tag.
    6. Make sure tests pass.
    7. Merge the PR.
  2. Tag a release using the Github UI
    1. Click "Draft a new release"
    2. Add a new tag vX.Y.Z
    3. Use vX.Y.Z as name
    4. Generate release notes, and edit to make it understandable to Github users.
    5. Create the release!
  3. After the tag is created, a Github Action to deploy to pypi will be triggered. Monitor to make sure this succeeds (click "Actions")
  4. Wait for the conda-forge PR to show up and merge that after checking that requirements have been updated.

dcherian avatar Jan 31 '23 17:01 dcherian

@kthyng you should have rights to create a release. Let's try it out!

Please add a whats-new note for #397

dcherian avatar Jan 31 '23 17:01 dcherian

Do you want me to add this as a docs page?

kthyng avatar Jan 31 '23 18:01 kthyng

Sure could go under "Contributing Guide", but let's make sure its comprehensive first.

dcherian avatar Jan 31 '23 18:01 dcherian

The recent releases don't really have anything in the release description. Should I just copy in the stuff from "What's New"?

kthyng avatar Jan 31 '23 18:01 kthyng

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.

dcherian avatar Jan 31 '23 18:01 dcherian

Um this is super awesome! I just clicked through and I see this, which looks very thorough:

image

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

Am I missing something?

kthyng avatar Jan 31 '23 19:01 kthyng

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.

dcherian avatar Jan 31 '23 20:01 dcherian

:clap: :clap: that worked well! https://pypi.org/project/cf-xarray/

dcherian avatar Jan 31 '23 20:01 dcherian

I think your instructions were good!

kthyng avatar Jan 31 '23 22:01 kthyng