🐡
TerraformをRenovateで自動バージョンアップし、PR作成とMergeを自動化する
1.Renovateとは？
- ドキュメントで
Automated dependency updates. Multi-platform and multi-language.と記載されています。
簡潔に言うと依存関係を自動で更新してくれるツールです。
バージョンアップしてくれ、PR作成~Mergeまで自動で行ってくれます。
2.Dependabotとの比較
Renovateを採用するメリット
- Renovateだと異なる種類の依存関係でも、プロジェクト単位で1つのPRにまとめてくれてPRの数が少なくなり管理が容易になる。
- Dependabotだと同じ種類の依存関係でもPRが分離されPR数が多くなってしまい管理がしにくい。
- 特定のパッケージやモジュールのみを更新対象にしたり、週に一度だけPRを作成するように設定できる等カスタマイズしやすい。
- Dependabotは、設定できるパラメータが限られており、Renovateほどの自由度がない。
- テストやレビューが不要な場合、PRの作成からマージまでを完全に自動化できる。(DependabotだとCIをセットにしないとMergeまでやってくれない)
- Dependabotは、更新後のコードがプロジェクトで正常に動作することを確認するためにCIでテストを実行する必要があるため。
3.前提
- RenovateとGithubが連携済みであること
https://github.com/apps/renovate
4.renovate.jsonの配置
- 基本的にはリポジトリの
ルートディレクトリor.github配下に配置します。
ルートディレクトリが最優先されるので、特別に理由がない場合はルートディレクトリに配置します。
5.コードとパラメータの解説
-
バージョンアップしたい対象
- terraformブロック
-
.terraform-verisonファイル - providerブロック
- 公式Module
-
スコープ
- Terraformのバージョン更新を自動で管理し、PR作成からMergeまでを自動化
- 個人用のリポジトリのため、更新優先のためメジャーバージョンも対象
-
備考
- 今回はCIテストをしなくても自動マージされるよう設定。
- RenovateのApprove用Botにレビュアーを対応させる。
- 個人用のリポジトリのため、Majorバージョンも自動マージに対照しています。(業務であればMajorはレビューする必要あります。)
takehiro1111/aws_terraform/renovate.json
// reference: https://docs.renovatebot.com/configuration-options/#additionalbranchprefix
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": [
"config:best-practices",
":label(renovate)",
":timezone(Asia/Tokyo)"
],
"configMigration": true,
"prHourlyLimit": 0,
"prConcurrentLimit": 0,
"schedule": [
"* 8-23,0-2 * * *"
],
"assignAutomerge": false,
"autoApprove": true,
"automerge": true,
"automergeType": "pr",
"automergeStrategy": "auto",
"rebaseWhen": "auto",
"dependencyDashboard": true,
"ignoreTests": true,
"ignoreReviewers": ["takehiro1111"],
"reviewers": ["Renovate Approve[bot]","Renovate Approve 2[bot]"],
"packageRules": [
{
"matchManagers": ["terraform", "terraform-version", "tflint-plugin"],
"additionalBranchPrefix": "{{packageFileDir}}-",
"commitMessageSuffix": "({{packageFileDir}})",
"matchUpdateTypes": ["major", "minor", "patch"],
"groupName": "terraform"
}
]
}
上記コードの結果、バージョン更新を行いPR作成〜Mergeまで自動化される。
参考
Discussion