Automate label-based Python release versioning with Release Drafter

Ouverte
#23 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

@imshubham22apr-gif y travaille déjà.

Depuis le 10/11/2026.

  • #24 par @imshubham22apr-gif — ouverte

Évaluation

Difficulté
5/5
Temps estimé
Plus d'une semaine
Accessibilité débutants
20/100
Type d'issue
Fonctionnalité
Clarté
Clairement spécifiée
Activité
À l'abandon
Stack technique
github, github-actions, python
Domaine
ci-cd, release

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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
Langage dominant
Python
Étoiles
0
Forks
4
Merge moyen
1 j 14 h
PR mergées (30 j)
11

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.