Automate label-based Python release versioning with Release Drafter

Aperta
#23 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@imshubham22apr-gif ci sta già lavorando.

Dal 10/11/2026.

  • #24 di @imshubham22apr-gif — aperta

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
20/100
Tipo di issue
Funzionalità
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
github, github-actions, python
Ambito
ci-cd, release

Direzione di ricerca

Read .github/workflows/release.yml, the existing publishing workflow, pyproject.toml, uv.lock, and the release guidance in CONTRIBUTING.md; first trace how a pushed v* tag reaches PyPI publishing. Define how PR labels resolve version bumps and how release creation triggers publishing despite GitHub token event restrictions. Done means the acceptance checks pass, including version and lockfile consistency, preserved publishing checks, and repeat runs without duplicate releases or publications.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement good first issue help wanted

Problem / Motivation

PyPI publishing is already automated for pushed v* tags, but preparing a release still requires manually updating the package version and creating a matching tag. There is currently no Release Drafter configuration or workflow to calculate the next version from pull-request labels and maintain release notes.

Current State

  • pyproject.toml declares a static package version (0.1.0).
  • .github/workflows/release.yml runs on pushed v* tags and rejects tags that do not match the declared package version.
  • CONTRIBUTING.md documents manually setting the version and pushing a matching tag.
  • The existing pipeline builds, verifies, publishes through PyPI Trusted Publishing, and verifies the published package.

Proposed Solution

Use Release Drafter to maintain draft release notes and resolve the next semantic version from labels on merged pull requests. Connect that resolved version to release preparation so package metadata, the lockfile, the GitHub release, and its tag stay consistent without manual version editing. Maintainers should retain control over when a release is published.

Acceptance Criteria

  • Add Release Drafter configuration and a workflow that maintains a draft release from merged PRs on the default branch.
  • Define and document labels for major, minor, and patch releases; use the highest applicable bump across merged PRs and document the behavior for unlabeled PRs.
  • Automatically prepare the resolved package version in pyproject.toml and keep uv.lock consistent before building release artifacts.
  • Ensure the release tag and published Python package version match, using a Python-compatible version format.
  • Explicitly connect the release/tag creation mechanism to the publishing pipeline, accounting for GitHub token event-trigger restrictions so an automated release actually starts publishing.
  • Preserve the existing build/verification checks, tag/version mismatch guard, and PyPI Trusted Publishing flow.
  • Verify patch/minor/major resolution, mixed-label precedence, unlabeled PR behavior, version/lockfile consistency, and repeat runs without duplicate releases or publications.
  • Update CONTRIBUTING.md with the label policy and maintainer release process.

Related Files

  • .github/workflows/release.yml
  • .github/workflows/publish-testpypi.yml
  • pyproject.toml
  • uv.lock
  • CONTRIBUTING.md
Lingua principale
Python
Stelle
0
Fork
4
Merge medio
1g 14h
PR unite (30g)
11

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.