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

Đang mở
#1,680 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 6 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
28/100
Loại issue
Tính năng
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
git, github-actions, python
Lĩnh vực
ci-cd, release

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
Python
Star
198
Fork
103
Merge trung bình
6 ngày 1 giờ
Pull request đã merge (30 ngày)
10

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của datajoint/datajoint-python

Tất cả issue của datajoint/datajoint-python

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.