Add release instructions

Open
#412 9 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
30/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
github-actions, python
Domain
ci-cd, documentation, release

Research direction

Start with whats-new.rst and CITATION.cff, then inspect recent commits and the test-build tag requirements. Run the test suite before creating the pull request, and monitor the GitHub Action after tagging the release. Done means the release notes and citation metadata are updated, the GitHub release is created, PyPI deployment succeeds, and the conda-forge PR is merged.

Written by the indexing model from the issue text.

Description

documentation
  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.
Dominant language
Python
Stars
181
Forks
49
Avg merge
43m
Merged PRs (30d)
1

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from xarray-contrib/cf-xarray

All issues in xarray-contrib/cf-xarray

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.