Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add release instructions #412

Open
dcherian opened this issue Jan 31, 2023 · 9 comments
Open

Add release instructions #412

dcherian opened this issue Jan 31, 2023 · 9 comments
Labels
documentation Improvements or additions to documentation

Comments

@dcherian
Copy link
Contributor

dcherian commented Jan 31, 2023

  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
Copy link
Contributor Author

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

Please add a whats-new note for #397

@kthyng
Copy link
Contributor

kthyng commented Jan 31, 2023

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

@dcherian
Copy link
Contributor Author

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

@dcherian dcherian added the documentation Improvements or additions to documentation label Jan 31, 2023
@kthyng
Copy link
Contributor

kthyng commented Jan 31, 2023

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

@dcherian
Copy link
Contributor Author

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.

@kthyng
Copy link
Contributor

kthyng commented Jan 31, 2023

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?

@dcherian
Copy link
Contributor Author

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
Copy link
Contributor Author

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

@kthyng
Copy link
Contributor

kthyng commented Jan 31, 2023

I think your instructions were good!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants