Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .github/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
changelog:
exclude:
labels:
- tagpr
categories:
- title: Changes
labels:
- '*'
64 changes: 20 additions & 44 deletions .github/workflows/README.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,32 @@
# GitHub Actions Workflows
# リリース手順

このディレクトリには、J-Quants Go ClientのCI/CDワークフローが含まれています。
[`tagpr.yml`](tagpr.yml) で [tagpr](https://github.com/Songmu/tagpr) を実行し、リリース PR と GitHub Release を作成します。設定は [`.tagpr`](../../.tagpr)、リリースノートの設定は [`.github/release.yml`](../release.yml) にあります。

## ワークフロー一覧
## 初回設定

### CI (`ci.yml`)
認証には GitHub Actions が発行する `GITHUB_TOKEN` を使用します。リポジトリの Settings → Actions → General → Workflow permissions で **Allow GitHub Actions to create and approve pull requests** を有効にしてください。tagpr に必要な書き込み権限はワークフロー内の `permissions` で指定しています。

プルリクエストやmainブランチへのプッシュ時に実行される基本的なCIワークフローです。
## リリースの作成

**トリガー:**
- Pull Request (mainブランチ向け)
- Push to main branch
1. 通常のプルリクエストを `main` にマージすると、未リリースの変更をまとめたリリース PR が作成・更新されます。
2. リリース PR のバージョンと `CHANGELOG.md` を確認します。利用者への影響など、自動生成された変更履歴に不足する説明はこの PR で補足します。
3. CI が承認待ちになったら、書き込み権限のある利用者が PR 画面の **Approve workflows to run** を選択し、CI の結果を確認します。リリース PR が更新された場合も、承認が必要になることがあります。[GitHub の実行条件](https://docs.github.com/en/actions/how-tos/write-workflows/choose-when-workflows-run/trigger-a-workflow)
4. リリース PR をマージすると、`v` 付きのバージョンタグと公開済みの GitHub Release が作成されます。

**ジョブ:**
1. **Test**: ビルドチェックと単体テストの実行
- Go 1.23を使用
- カバレッジレポートをCodecovにアップロード
2. **Lint**: golangci-lintによるコード品質チェック
3. **Security**: Gosecによるセキュリティスキャン
リリース PR は、公開したいタイミングまで開いたままにできます。`main` に変更が追加されると内容が更新されます。`CHANGELOG.md` は最初のリリース PR で生成されます。

### Release (`release.yml`)
## バージョンの選択

新しいバージョンのリリース時に実行されるワークフローです。
既定は patch 更新です。minor・major 更新はリリース PR のラベルで指定します。通常の変更 PR に `minor` または `major` ラベルを付けてマージすると、対応するラベルがリリース PR に反映されます。

**トリガー:**
- タグプッシュ(`v*`パターン)
| リリース PR のラベル | 更新例 |
|---------------------|--------|
| 指定なし | `v0.8.0` → `v0.8.1` |
| `tagpr:minor` | `v0.8.0` → `v0.9.0` |
| `tagpr:major` | `v0.8.0` → `v1.0.0` |

**ジョブ:**
1. テストの実行
2. 変更履歴の生成
3. GitHubリリースの作成
開いているリリース PR の `tagpr:minor`・`tagpr:major` ラベルを手動で追加・削除すると、tagpr が再実行され、PR タイトルと `CHANGELOG.md` のバージョンが更新されます。更新が完了してから内容と CI の結果を確認してください。

## ローカルでのテスト
通常の変更 PR のラベルから反映されたバージョン指定を取り消す場合は、先に元の変更 PR の `minor`・`major` ラベルを削除してください。リリース PR 側のラベルだけを削除すると、再実行時に付け直されます。

GitHub Actionsのワークフローをローカルでテストする場合は、[act](https://github.com/nektos/act)を使用できます:

```bash
# CIワークフローをテスト
act pull_request

# リリースワークフローをテスト
act push --eventpath event.json
```

## トラブルシューティング

### Lintエラーが発生する場合

ローカルで以下を実行して修正:

```bash
make lint
# または
golangci-lint run --fix
```
タグだけでバージョンを管理するため、PR タイトルを編集してもリリースバージョンは変わりません。ラベルの詳細は [tagpr のバージョン指定方法](https://github.com/Songmu/tagpr/blob/v1.20.3/docs/guides/versioning.md)を参照してください。
10 changes: 5 additions & 5 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
go-version: ['1.24', '1.25']
go-version: ['1.25', '1.26', '1.27']

steps:
- name: Checkout code
Expand Down Expand Up @@ -64,12 +64,12 @@ jobs:
- name: Set up Go
uses: actions/setup-go@v5
with:
go-version: '1.24'
go-version: '1.25'

- name: golangci-lint
uses: golangci/golangci-lint-action@v6
uses: golangci/golangci-lint-action@v9
with:
version: latest
version: v2.13.2
args: --timeout=5m

security:
Expand All @@ -83,4 +83,4 @@ jobs:
- name: Run Gosec Security Scanner
uses: securego/gosec@master
with:
args: ./...
args: ./...
43 changes: 43 additions & 0 deletions .github/workflows/tagpr.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: tagpr

on:
push:
branches: [main]
pull_request_target:
branches: [main]
types: [labeled, unlabeled]

permissions:
contents: write
pull-requests: write
issues: read

jobs:
tagpr:
if: >-
github.event_name == 'push' ||
(
github.event.pull_request.state == 'open' &&
github.event.pull_request.head.repo.full_name == github.repository &&
startsWith(github.event.pull_request.head.ref, 'tagpr-from-') &&
contains(github.event.pull_request.labels.*.name, 'tagpr') &&
(github.event.label.name == 'tagpr:minor' || github.event.label.name == 'tagpr:major')
)
runs-on: ubuntu-latest
concurrency:
group: tagpr
cancel-in-progress: false
queue: max
steps:
- name: Checkout code
uses: actions/checkout@v4
with:
# An empty ref preserves the push event's commit for release detection.
ref: ${{ github.event_name == 'pull_request_target' && 'main' || '' }}
persist-credentials: false
fetch-depth: 0

- name: Create release pull request or release
uses: Songmu/tagpr@v1.20.3
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ go.work.sum
tmp/
# 公式APIドキュメントのローカルキャッシュ(make docs-sync で取得)
docs/v2/
docs/ai/

# IDE specific files
.idea/
Expand Down
6 changes: 6 additions & 0 deletions .tagpr
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[tagpr]
releaseBranch = main
versionFile = -
vPrefix = true
changelog = true
release = true
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ clean:
# 開発ツールのインストール
install-tools:
@echo "golangci-lintをインストール中..."
go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@v2.13.2
@echo "開発ツールのインストールが完了しました"

# 全テスト実行(単体テスト + リント)
Expand All @@ -83,4 +83,4 @@ mod-download:

# 公式APIドキュメントを docs/v2/ に同期(ローカルキャッシュ。コミットしない)
docs-sync:
./scripts/sync-docs.sh
./scripts/sync-docs.sh
Loading
Loading