Release from the GitHub UI: write the notes in a draft release, and let a workflow make the annotated tag

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

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

まだ誰も着手していません。

評価

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

調査の方向性

Start by reading RELEASE_MEMO.md and the existing release workflow release.yaml, then trace how annotated tags trigger builds and publishing. The issue specifies a new workflow_dispatch workflow and its release handoff; done means browser and terminal releases both produce the same annotated tag, published artifacts, and PyPI upload, with a dry run that validates without tagging.

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

説明

enhancement

Since #1588, a release is an annotated tag whose message is the release notes. The release workflow refuses lightweight tags, and RELEASE_MEMO.md says not to create the tag from the Releases page, because that page creates a lightweight tag.

That leaves one way to release: from a terminal, with git tag -a vX.Y.Z --cleanup=verbatim -F -. A maintainer who works from the browser can't release, and writing notes in a heredoc is less pleasant than in the release editor.

Proposal

  1. The maintainer creates a draft release on the Releases page with the notes in its body, for the tag vX.Y.Z (the tag is not created yet).
  2. A workflow_dispatch workflow, "Tag release", takes the version as input. It:
    • reads the draft release's body;
    • checks that the version is new and that the target commit is on master;
    • creates the annotated tag with that body as its message;
    • pushes it.
  3. release.yaml builds and publishes. When it finds the draft release for the tag, it fills that release in and publishes it, instead of creating a new one.

Constraint

A tag pushed with GITHUB_TOKEN does not trigger other workflows. Either:

  • "Tag release" calls release.yaml through workflow_call after pushing the tag; or
  • it pushes with a GitHub App token, so the tag push triggers release.yaml as usual.

workflow_call keeps credentials simpler. The App token keeps one path for terminal and UI releases.

Acceptance criteria

  • A release can be made entirely in the browser, and the result matches a terminal release: an annotated tag whose message is the notes, a published release with the built artifacts, and a PyPI upload.
  • The terminal path from RELEASE_MEMO.md keeps working unchanged.
  • The memo describes both paths.
  • A dry-run input on "Tag release" validates without tagging.

Related

Restricting who can create v* tags with a tag ruleset is a repository setting, handled separately.

主要言語
Python
スター
198
フォーク
103
平均マージ
6日 1時間
マージ済み PR(30日)
10

環境構築

はじめの一歩

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

datajoint/datajoint-python のほかの issue

datajoint/datajoint-python の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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