Zenn
Closed10

GitHub の Automatically generated release notes

GitHub
hankei6kmhankei6km

現状でわかっているのは以下のとおり。

  • ウェブ UI と GitHub CLI で使える
  • .github/release.yml を作成するとカテゴリーわけできる(release.yaml も有効)
  • .github/release.ymlは GitHub 上のデフォルトブランチに存在していないと有効にならない
    • 対象となるタグより前に追加されていないと有効にならない
hankei6kmhankei6km
  • previous_tag_name で指定したタグは release.yml 追加前でも有効
  • configuration_file_path は存在しないファイルを指定するとエラー
    gh: Could not find a configuration file at .github/release_alt (HTTP 400)
hankei6kmhankei6km

ウェブの UI から上記パラメーターの指定はできなさそう。

hankei6kmhankei6km

configuration_file_path 切り替え。

$ gh api /repos/{owner}/{repo}/releases/generate-notes -f tag_name=v0.3.0 -f previous_tag_name=v0.1.0 --jq .body
<!-- Release notes generated using configuration in .github/release.yml at v0.3.0 -->

## What's Changed
### Features
* Make function two by @hankei6km in https://github.com/hankei6km/test-release-generate-notes/pull/4
* Make function three by @hankei6km in https://github.com/hankei6km/test-release-generate-notes/pull/6
### Bug Fixes
* Fix query by @hankei6km in https://github.com/hankei6km/test-release-generate-notes/pull/7
### Other Changes
* Add section to README by @hankei6km in https://github.com/hankei6km/test-release-generate-notes/pull/5
* Add release config files by @hankei6km in https://github.com/hankei6km/test-release-generate-notes/pull/8


**Full Changelog**: https://github.com/hankei6km/test-release-generate-notes/compare/v0.1.0...v0.3.0

$ gh api /repos/{owner}/{repo}/releases/generate-notes -f tag_name=v0.3.0 -f previous_tag_name=v0.1.0 -f configuration_file_path=".github/release_alt.yml" --jq .body
<!-- Release notes generated using configuration in .github/release_alt.yml at v0.3.0 -->

## What's Changed
### 機能追加
* Make function two by @hankei6km in https://github.com/hankei6km/test-release-generate-notes/pull/4
* Make function three by @hankei6km in https://github.com/hankei6km/test-release-generate-notes/pull/6
### バグ修正
* Fix query by @hankei6km in https://github.com/hankei6km/test-release-generate-notes/pull/7
### その他の変更
* Add section to README by @hankei6km in https://github.com/hankei6km/test-release-generate-notes/pull/5
* Add release config files by @hankei6km in https://github.com/hankei6km/test-release-generate-notes/pull/8


**Full Changelog**: https://github.com/hankei6km/test-release-generate-notes/compare/v0.1.0...v0.3.0
hankei6kmhankei6km

ちょっと探した限りでは GraphQL API のスキーマはなさそう。

hankei6kmhankei6km

GitHub CLI の gh release create でもパラメーターの指定はなさそうなので、使おうと思ったら編集時に vim から :r!gh api で取得かな。

hankei6kmhankei6km

以下のようなファイルを用意してconfiguration_file_path を使えばラベルでフィルタリングできそうなことに気が付く。

これがあればラベル一覧のアクションなくても大丈夫なのでは。

release_filter_types.yml
changelog:
  categories:
    - title: Types
      labels:
        - types
    - title: Other Changes
      labels:
        - '*'
このスクラップは2022/02/01にクローズされました