release-drafterでGitHubのリリースドラフトを自動生成するための設定

設定方法

以下の2つのYAMLファイルを配置するだけ

code:.github/release-drafter.yml

name-template: 'v$NEXT_PATCH_VERSION'

tag-template: 'v$NEXT_PATCH_VERSION'

categories:

- title: '🚀 Features'

labels:

- 'feature'

- 'enhancement'

- title: '🐛 Bug Fixes'

labels:

- 'fix'

- 'bugfix'

- 'bug'

- title: '🧰 Maintenance'

label: 'chore'

change-template: '- $TITLE @$AUTHOR (#$NUMBER)'

template: |

$CHANGES

code:.github/workflows/main.yml

name: test

on:

push:

branches:

- master

jobs:

create-tag-draft:

runs-on: ubuntu-latest

steps:

- uses: release-drafter/release-drafter@v5.3.1

env:

GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

設定の意味

masterブランチにpushしたときだけリリースドラフトを生成する

リリースドラフトがすでにある状態で実行したら過去のドラフトを上書きする

ドラフトの整理とかはしなくてよい

よしなにやってくれる