ably-python icon indicating copy to clipboard operation
ably-python copied to clipboard

chore: update CONTRIBUTING.md with revised release process steps

Open ttypic opened this issue 1 month ago • 1 comments

update CONTRIBUTING.md with revised release process steps

Summary by CodeRabbit

  • Documentation
    • Updated contribution guidelines with a new release workflow. The release process now uses GitHub releases with approval-based publishing to PyPI, replacing the previous automated build-and-publish sequence. Changelog update procedures have been reorganized accordingly.

ttypic avatar Oct 31 '25 14:10 ttypic

Walkthrough

The CONTRIBUTING.md release process was rewritten to remove direct build/publish steps and introduce a GitHub release → tag → approval workflow for PyPI publishing; the changelog update was retained and moved to after release notes with a simplified generator example.

Changes

Cohort / File(s) Summary
Contribution guide
CONTRIBUTING.md
Removed synchronous build/publish/tag steps (poetry build/publish, automatic tagging). Added guidance to create a GitHub release with a tag and use a Release Workflow that requires explicit approval before publishing to PyPI. Repositioned changelog update to occur after release notes and simplified the changelog-generator example (references v1.0.0).

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant GH as GitHub
    participant ReleaseWF as Release Workflow
    participant PyPI as PyPI
    participant Changelog as Changelog

    Dev->>GH: Create tag & GitHub Release
    GH->>ReleaseWF: Trigger release workflow (await approval)
    Note over ReleaseWF: Approval required before publish
    ReleaseWF-->>PyPI: Publish package (post-approval)
    PyPI-->>ReleaseWF: Confirm publish
    Dev->>Changelog: Update changelog with release notes
    Changelog-->>Dev: Changelog updated

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Single documentation file changed.
  • Verify clarity of new release-approval steps and that the changelog example matches repository conventions.
  • Check no remaining references to the removed automated build/publish commands.

Poem

🐰 The tag I plant, the release I sing,

Approvals drum before bells ring.
Changelog hops in after the show,
Then PyPI welcomes what we sow. 🥕

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: updating CONTRIBUTING.md with revised release process steps, which aligns with the provided summary.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • [ ] Create PR with unit tests
  • [ ] Post copyable unit tests in a comment
  • [ ] Commit unit tests in branch update-contributing-guide

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

coderabbitai[bot] avatar Oct 31 '25 14:10 coderabbitai[bot]