mk3008 / mk3008/rawsql-ts

release: add a pre-tag completeness check for changesets and release inclusion

Open
#710 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
30
Forks
1
PR merge metrics
No merged PRs in 30d

Description

Background

タグ作成前の確認において、直近でマージされた変更が今回の release に含まれるのか、あるいは次回へ見送るのかが明確でないまま進むと、changeset の取りこぼしや changelog 反映漏れが発生しやすくなります。

特に、release PR 作成時点より前に merge 済みであっても、release に含める判断と evidence が揃っていない変更が残ると、タグ後の説明や追加修正が必要になります。

Problem

現在の release preparation では、"このタグに含める変更" と "今回は含めない変更" の境界がタグ前に明示されないまま進む可能性があります。

その結果、以下のような状態が起こりえます。

  • changeset が必要な変更の取りこぼし
  • changelog に含めるべき変更の反映漏れ
  • release 後に「今回載ると思っていた変更」が未反映であることに気づく
  • 逆に、今回は載せない変更の扱いが曖昧になる

Proposal

タグ前の標準確認として、release completeness check を追加したいです。

少なくとも以下を確認対象にします。

  • release PR 作成時点までに merge 済みの対象 PR 一覧
  • 各 PR が今回の release に含まれるかどうか
  • changeset が必要な変更に changeset が存在するか
  • changeset が不要な変更は、その理由が明示されているか
  • 今回含めない変更がある場合は、その旨が明示されているか

重要なのは、実装を複雑にすることではなく、タグ前に "release inclusion の判断が閉じている" 状態を作ることです。

Expected benefit

  • changeset や changelog の取りこぼしを減らせる
  • タグ後の補足説明や追加修正を減らせる
  • reviewer と maintainer が release scope を共有しやすくなる
  • release note の説明責任を果たしやすくなる

Definition of done

  • タグ前に確認する release completeness の項目が定義される
  • 直近 merge 分について "含める / 含めない / changeset 不要" の判断を記録する運用が決まる
  • release PR または release checklist から、その判断を追跡できる
  • 同種の changeset 取りこぼしや release inclusion の曖昧さを減らせる状態になる

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files or tests; start by locating the repository's release PR and release checklist workflow, then review how merged PRs and changesets are currently recorded. Define the pre-tag inclusion evidence and make it traceable from the release PR or checklist; done means each recent merge is marked included, excluded, or changeset-free.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
release
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.