hene

hene.dev

GitHub のリリースノートを活用して、じぶんリリースノートを素早く作成する

GitHub のリリースノートを活用して、じぶんリリースノートを素早く作成する

ちゃんとしたリリースがないプロジェクトでも GitHub のリリースと Git タグを活用する - hene.dev に書いた内容で、自分が携わっている会社のプロジェクトは振り返りを行っています。

じぶんリリースノート を書く際にも活用できそうだったので、同じように設定してみました。 過去に書いた じぶんリリースノート は、 Tag: じぶんリリースノート - hene.dev にあります。

やりたいこと

できるだけ工数をかけずに じぶんリリースノート を投稿したい。

運用

  • やったことは、できるだけブログに書く
  • ブログを書いたプルリクエストに、blog のラベルを付与する
  • GitHub のリリースノートで、blog のラベルを付与したプルリクエストを確認
  • じぶんリリースノート を書く際に GitHub のリリースノートを参考に何をやったかまとめる

じぶんリリースノートの書き方

設定

ラベルの管理

デフォルトのラベルの使い方は、 ラベルを管理する - GitHub Docs にまとまっている。

使いやすいように、ラベルを下記のように整理した。

  • blog: ブログの追加・更新
  • log: ログの追加・更新

下 3 つは、ブログを管理している Next.js 用のラベル。 今後、ブログの中身の Markdown と ブログを管理しているプロジェクト の 2 つに分割したい。

  • bug: バグ修正
  • enhancement: 新機能の追加
  • refactoring: リファクタリング

Labels

.github/release.yml の設定

.github/release.yml を作成した。 blog,log, bug, enhancement, refactoring のラベルを付与すると自動で埋めてくれる。

changelog:
  categories:
    - title: 投稿したブログ
      labels:
        - blog
    - title: 投稿したログ
      labels:
        - log
    - title: 新機能
      labels:
        - enhancement
    - title: リファクタリング
      labels:
        - refactoring
    - title: バグ修正
      labels:
        - bug
    - title: 他
      labels:
        - "*"

GitHub のリリースノート作成例

https://github.com/OWNER_NAME/REPOSITOR_NAME/releases/new を開き、 Choose a tag -> タグ名を入力 -> Create new tag -> Generate release notes で作成できる。

<!-- Release notes generated using configuration in .github/release.yml at main -->

## What's Changed
### 投稿したブログ
<!-- 略 -->
* 2024 年に読む本・読んだ本 by @OWNER_NAME in https://github.com/OWNER_NAME/REPOSITOR_NAME/pull/210
* データマネジメント新年会 〜去年のしくじりを共有し、正月ボケを解消する〜 に参加した by @OWNER_NAME in https://github.com/OWNER_NAME/REPOSITOR_NAME/pull/213
* 2024 年の目標 by @OWNER_NAME in https://github.com/OWNER_NAME/REPOSITOR_NAME/pull/221
### 新機能
<!-- 略 -->
* .github/release.yml の追加 by @OWNER_NAME in https://github.com/OWNER_NAME/REPOSITOR_NAME/pull/224
### リファクタリング
<!-- 略 -->
* Update README.md by @OWNER_NAME in https://github.com/OWNER_NAME/REPOSITOR_NAME/pull/223

## New Contributors
* @OWNER_NAME made their first contribution in https://github.com/OWNER_NAME/REPOSITOR_NAME/pull/1

**Full Changelog**: https://github.com/OWNER_NAME/REPOSITOR_NAME/commits/v0.28.6

New Release

参考

関連記事

← Back to home