リリースノート管理術

みなさま、OSSの変更履歴、要するにCHANGELOGやリリースノートはどのように管理しておられるでしょうか。自分はというと、抱えるリポジトリも数百個に増えてきて、まあ要するに細かく管理するのがだるく、最近は変更履歴の管理方法も変わってきました。 CHANGELOGからGitHub Releasesへ 昔は、おおよそKeep a changelogの方式に準拠したCHANGELOG.mdを書いていました。semantic versioningでバージョン管理をしながら、個々のバージョンごとに次のセクションを設けて変更内容を説明するような感じです。 Added Changed Deprecated Fixed Removed Security 今は、新規につくるリポジトリではCHANGELOG.mdは用意せず、GitHub ReleasesにKeep a changelogに似た形式で変更内

[syque]

“.github/release.ymlという定義ファイルを用意しておけば、Pull Requestに付いているラベルごとにセクションを分けてくれる機能も付いています”

[razokulover]

いくつか試してみたいやつあったので後でやってみる

[dorapon2000]

“GitHubはリリースノートを自動生成する機能を備えています。そのバージョンでMergeされたPull Request達をまとめてくれる機能です。”

[efcl]

GitHub Releasesを管理するActions

[yug1224]

gitlabも同じ方法欲しい。出来ないのだろうか。

[yarumato]

“今は、新規につくるリポジトリではCHANGELOG.mdは用意せず、GitHub ReleasesにKeep a changelogに似た形式で変更内容を記載することにしています。GitHubはリリースノートを自動生成する機能を備えています。”

[mizdra]

良い。リリースノート自動生成用の GitHub API 便利そう。