Automate label-based Python release versioning with Release Drafter

オープン
#23 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

@imshubham22apr-gif がすでに取り組んでいます。

2026年11月10日 から。

  • #24 @imshubham22apr-gif による — オープン

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
20/100
issue の種類
機能追加
明瞭さ
明確に書かれている
活発さ
停滞
技術スタック
github, github-actions, python
領域
ci-cd, release

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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
主要言語
Python
スター
0
フォーク
4
平均マージ
1日 14時間
マージ済み PR(30日)
11

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。