Skip to content

Document and rehearse the maintainer release procedure - #681

Open
nawaaaaaAaar wants to merge 1 commit into
xarray-contrib:mainfrom
nawaaaaaAaar:docs/releasing
Open

nawaaaaaAaar wants to merge 1 commit into
xarray-contrib:mainfrom
nawaaaaaAaar:docs/releasing

Conversation

@nawaaaaaAaar

Copy link
Copy Markdown
Contributor

Summary

Fixes #412. Follow-up to my merged #674 and #675.

Document the maintainer release procedure in a page linked from the contribution guide, based on the current pypi.yaml, testpypi-release.yaml and ci.yaml.

  • Explain tag-derived versions, build rehearsal, artifact checks and clean-wheel verification outside the source tree.
  • Distinguish the three existing events: the test-build/manual rehearsal builds without upload; pushing a v* tag publishes to TestPyPI; publishing the GitHub Release publishes to PyPI.
  • Explain the protected pypi environment, trusted publishing and post-release verification.
  • Explicitly warn that TestPyPI is a real publication and that CI's git clean -xdf must not be copied into an ordinary working checkout.

This is documentation only. It changes no release workflow, permissions, package version, tag or published release.

Validation

  • Compared each procedural step against the repository's current workflows.
  • Sdist and wheel build; twine check --strict dist/* passes for both.
  • A new Python 3.12 environment installs the wheel. Outside the checkout, python -m cf_xarray.scripts.print_versions and the documented version/import checks pass.
  • Sphinx HTML build passes with notebook execution disabled: 95 warnings, exactly the same as unchanged upstream, none from the new release page.
  • All pre-commit hooks and git diff --check pass.
  • No code tests were added for a documentation-only change; the executable build/install rehearsal above verifies the new local procedure.

AI-assisted contribution: documentation, workflow review and checks were performed by the assistant. No tags were pushed, workflows manually dispatched or packages uploaded.

Copilot AI balanced review requested due to automatic review settings October 22, 2026 14:37

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing.

@codecov

codecov Bot commented Oct 22, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.13%. Comparing base (a9cebee) to head (c11fb08).
⚠️ Report is 132 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #681      +/-   ##
==========================================
+ Coverage   85.78%   87.13%   +1.35%     
==========================================
  Files          13       16       +3     
  Lines        2364     3351     +987     
  Branches      183      313     +130     
==========================================
+ Hits         2028     2920     +892     
- Misses        303      385      +82     
- Partials       33       46      +13     
Flag Coverage Δ
mypy 46.07% <ø> (+7.54%) ⬆️
unittests 92.84% <ø> (-1.15%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add release instructions

2 participants