Release from the GitHub UI: write the notes in a draft release, and let a workflow make the annotated tag
維護者通常 6 天內回覆
還沒有人認領這個 Issue。
評估
- 難度
- 5/5
- 預估耗時
- 一週以上
- 新手友好度
- 28/100
研究方向
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 內容生成。
描述
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
- 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). - A
workflow_dispatchworkflow, "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.
release.yamlbuilds 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.yamlthroughworkflow_callafter pushing the tag; or - it pushes with a GitHub App token, so the tag push triggers
release.yamlas 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.mdkeeps 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 小時
- 30 天內合併 PR
- 10
環境準備
- 提供 Dockerfile 或 Docker Compose 檔案
- 沒有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
datajoint/datajoint-python 的其他 Issue
-
bug
難度 2/5 1-3 小時 新手友好度 78/100
datajoint/datajoint-python#1703 ·
維護者通常 6 天內回覆
-
bug
難度 2/5 1-3 小時 新手友好度 78/100
datajoint/datajoint-python#1702 ·
維護者通常 6 天內回覆
-
bug
難度 2/5 1-3 小時 新手友好度 78/100
datajoint/datajoint-python#1701 ·
維護者通常 6 天內回覆
-
bug
難度 2/5 1-3 小時 新手友好度 74/100
datajoint/datajoint-python#1691 ·
維護者通常 6 天內回覆
-
dependencies needs-discussion
難度 2/5 1-3 小時 新手友好度 68/100
datajoint/datajoint-python#1687 ·
維護者通常 6 天內回覆
查看 datajoint/datajoint-python 的全部 Issue
相似的 Issue
-
needs-triage
難度 1/5 1-3 小時 新手友好度 85/100
gke-labs/kube-agents#6620 ·
維護者通常 1 天內回覆
-
bug
難度 2/5 1-3 小時 新手友好度 75/100
open-webui/open-webui#34719 · 2 則留言 ·
維護者通常 1 天內回覆
-
cognition
難度 2/5 1-3 小時 新手友好度 82/100
維護者通常 1 天內回覆
-
One non-object JSON record makes the session catalog exit可能已有人在做 @he-yufeng 今天認領。 未關閉
難度 2/5 1-3 小時 新手友好度 68/100
維護者通常 1 天內回覆
-
難度 1/5 1 小時以內 新手友好度 78/100
collabnix/awesome-mcp-lists#433 ·
維護者通常 4 天內回覆