## GitHub Actionsを使ってCHANGELOGを自動生成する設定例

### 目次
1. はじめに
2. 必要なツールと準備
    - 2-1. `semantic-release`の紹介
    - 2-2. リポジトリの準備
3. GitHub Actionsの設定
    - 3-1. ワークフローファイルの作成
    - 3-2. ジョブの詳細設定
4. `semantic-release`の設定
    - 4-1. `package.json`での設定
    - 4-2. `release.config.js`での設定
5. リリースプロセスの流れ
6. まとめ

### 1. はじめに

現代のソフトウェア開発では、CHANGELOGは重要な役割を果たしています。変更履歴を追跡することは、開発者や利用者にとって大変重要です。この記事では、GitHub Actionsを用いて、`semantic-release`を活用し、CHANGELOGを自動生成する方法について解説します。

### 2. 必要なツールと準備

#### 2-1. `semantic-release`の紹介

`semantic-release`は、コードのコミットメッセージに基づいてバージョン番号を決定し、CHANGELOGを自動生成するツールです。これにより、手動のバージョン管理の労力を削減できます。

#### 2-2. リポジトリの準備

まず、あなたのGitHubプロジェクトリポジトリを用意します。そして、以下のコマンドを使用して、`semantic-release`をインストールします。

```bash
npm install --save-dev semantic-release @semantic-release/changelog @semantic-release/git
```

### 3. GitHub Actionsの設定

#### 3-1. ワークフローファイルの作成

GitHub ActionsでCHANGELOGを自動生成するために、新しいワークフローファイルを作成します。リポジトリの`.github/workflows`ディレクトリ内に`release.yml`を作成します。

```yaml
name: Release

on:
  push:
    branches:
      - main

jobs:
  release:
    runs-on: ubuntu-latest

    steps:
    - name: Check out repository
      uses: actions/checkout@v2

    - name: Set up Node.js
      uses: actions/setup-node@v2
      with:
        node-version: '14'

    - name: Install dependencies
      run: npm install

    - name: Create Release
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      run: npx semantic-release
```

#### 3-2. ジョブの詳細設定

- `actions/checkout@v2`：リポジトリの最新のコードをチェックアウトします。
- `actions/setup-node@v2`：指定ノードバージョンを設定します。ここではNode.js 14を使用しています。
- `npm install`：必要な依存関係をインストールします。
- `npx semantic-release`：semantic-releaseを実行して、バージョンアップやCHANGELOGの生成を行います。

### 4. `semantic-release`の設定

#### 4-1. `package.json`での設定

`package.json`を開き、以下のように`release`フィールドを追加します。

```json
"release": {
  "branches": ["main"]
}
```

#### 4-2. `release.config.js`での設定

`release.config.js`というファイルをプロジェクトのルートに作成し、以下を記述します：

```javascript
module.exports = {
  plugins: [
    '@semantic-release/commit-analyzer',
    '@semantic-release/release-notes-generator',
    '@semantic-release/changelog',
    ['@semantic-release/git', {
      'assets': ['CHANGELOG.md', 'package.json'],
      'message': 'chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}'
    }]
  ]
};
```

### 5. リリースプロセスの流れ

1. `main`ブランチにプッシュするたびに、GitHub Actionsがトリガーされます。
2. `semantic-release`がコミットメッセージを解析し、必要に応じてバージョンを上げます。
3. CHANGELOGが自動で更新され、コミットとともにPushされます。

### 6. まとめ

この設定により、CHANGELOGの管理を自動化し、リリースプロセスを効率化できます。`semantic-release`を使用することで、コードのコミット履歴からバージョン管理を行うため、エンジニアの負担を軽減できます。ぜひ、ご自身のプロジェクトに導入して、作業効率の改善を図ってみてください。 [cv:issue_marketplace_engineer]

GitHub Actionsを使ってCHANGELOGを自動生成する設定例

目次

続きを読むには単価診断を受けてください（30秒）