Skip to content

Add comprehensive release process documentation - #427

Merged
vhaasteren merged 2 commits into
nanograv:masterfrom
vhaasteren:make-release
Jul 15, 2026
Merged

Add comprehensive release process documentation#427
vhaasteren merged 2 commits into
nanograv:masterfrom
vhaasteren:make-release

Conversation

@vhaasteren

@vhaasteren vhaasteren commented Oct 22, 2025

Copy link
Copy Markdown
Member

Summary

This PR adds detailed documentation for the enterprise release process, which is fully automated but was not clearly documented.

Changes Made

  • Added RELEASE.md: Comprehensive release documentation including:
    • Fully automated release process via GitHub Actions
    • Explanation of trusted publishing setup
    • Version management via setuptools_scm
    • Troubleshooting and release checklist
  • Updated CONTRIBUTING.rst: Added "For Maintainers" section with link to release documentation

Release Process Documented

  • Fully automated PyPI uploads via GitHub Actions
  • Trusted publishing (no API tokens needed)
  • Version management via setuptools_scm (automatic from git tags)
  • GitHub environment configuration requirements

Benefits

  • Clear understanding of the automated process
  • Documentation of trusted publishing approach
  • Easier troubleshooting when issues arise
  • Better maintainer onboarding

@codecov

codecov Bot commented Oct 22, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 72.59%. Comparing base (3668246) to head (bb064d5).
⚠️ Report is 37 commits behind head on master.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #427      +/-   ##
==========================================
- Coverage   72.61%   72.59%   -0.02%     
==========================================
  Files          13       13              
  Lines        3407     3478      +71     
==========================================
+ Hits         2474     2525      +51     
- Misses        933      953      +20     

Continue to review full report in Codecov by Harness.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c55d2dd...bb064d5. Read the comment docs.

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

@vhaasteren vhaasteren linked an issue Oct 22, 2025 that may be closed by this pull request
@vhaasteren
vhaasteren removed the request for review from AaronDJohnson July 15, 2026 13:50
@vhaasteren
vhaasteren merged commit b58b0c1 into nanograv:master Jul 15, 2026
14 checks passed
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 comprehensive release process documentation

1 participant