Skip to content

Conversation

@vhaasteren
Copy link
Member

@vhaasteren vhaasteren commented Oct 22, 2025

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

codecov bot commented Oct 22, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.58%. Comparing base (90dfa56) to head (bf6286d).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #427   +/-   ##
=======================================
  Coverage   71.58%   71.58%           
=======================================
  Files          13       13           
  Lines        3245     3245           
=======================================
  Hits         2323     2323           
  Misses        922      922           

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6335ff7...bf6286d. 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
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