コンテンツにスキップ

リリースドラフト自動生成

概要

GitHub Actionsを利用して、リリースドラフトを自動生成する方法を紹介します。

準備

リリースドラフトを自動生成するためには、以下の準備が必要です。

  1. .github/workflows/release.ymlを作成する
  2. .github/release-drafter.ymlを作成する

.github/workflows/release.yml

リリースドラフトを自動生成するためのワークフローファイルを作成します。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
name: Release Drafter

on:
  push:
    branches:
      - develop
  pull_request:
    types: [opened, synchronize, reopened, closed]

jobs:
  update_release_drafter:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Run Release Drafter
        uses: release-drafter/release-drafter@v6
        with:
          config-name: release-drafter.yml
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/release-drafter.yml

リリースドラフトのテンプレートを作成します。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
name-template: 'v$RESOLVED_VERSION'
tag-template: 'v$RESOLVED_VERSION'
categories:
  - title: '🎉 リリース'
    labels:
      - 'major'
  - title: '🚀 機能追加'
    labels:
      - 'feature'
  - title: '🐛 バグ修正'
    labels:
      - 'bug'
  - title: '📝 その他'
exclude-labels:
  - 'ignore-for-release-note'
change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
change-title-escapes: '\<*_&'
version-resolver:
  major:
    labels:
      - 'major'
  minor:
    labels:
      - 'minor'
  default: patch
template: |
  $CHANGES
footer: |
  ## 🌱 すべての変更点
  https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION

コメント