<img src="https://res.cloudinary.com/zenn/image/fetch/s--Yv18DBYe--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_1200/https://storage.googleapis.com/zenn-user-upload/deployed-images/fc4f1b71686e1ee19c386de7.png%3Fsha%3D3a7f1cbd2dc4a9d5b7fe3d5b67d1c2b11345feb8" loading="lazy" class="md-img">
<h2 id="1.renovate%E3%81%A8%E3%81%AF%EF%BC%9F" data-line="2" class="code-line">
<a class="header-anchor-link" href="#1.renovate%E3%81%A8%E3%81%AF%EF%BC%9F" aria-hidden="true"></a> 1.Renovateとは？</h2>
<ul data-line="3" class="code-line">
<li data-line="3" class="code-line">ドキュメントで<code>Automated dependency updates. Multi-platform and multi-language.</code>と記載されています。 
簡潔に言うと依存関係を自動で更新してくれるツールです。 
バージョンアップしてくれ、PR作成~Mergeまで自動で行ってくれます。</li>
</ul>
<aside class="msg message">!<div class="msg-content">
reference:<a href="https://docs.renovatebot.com/" target="_blank" rel="nofollow noopener noreferrer">https://docs.renovatebot.com/</a>
</div></aside>
<h1 id="2.dependabot%E3%81%A8%E3%81%AE%E6%AF%94%E8%BC%83" data-line="10" class="code-line">
<a class="header-anchor-link" href="#2.dependabot%E3%81%A8%E3%81%AE%E6%AF%94%E8%BC%83" aria-hidden="true"></a> 2.Dependabotとの比較</h1>
<h3 id="renovate%E3%82%92%E6%8E%A1%E7%94%A8%E3%81%99%E3%82%8B%E3%83%A1%E3%83%AA%E3%83%83%E3%83%88" data-line="11" class="code-line">
<a class="header-anchor-link" href="#renovate%E3%82%92%E6%8E%A1%E7%94%A8%E3%81%99%E3%82%8B%E3%83%A1%E3%83%AA%E3%83%83%E3%83%88" aria-hidden="true"></a> Renovateを採用するメリット</h3>
<ul data-line="12" class="code-line">
<li data-line="12" class="code-line">Renovateだと異なる種類の依存関係でも、プロジェクト単位で1つのPRにまとめてくれてPRの数が少なくなり管理が容易になる。
<ul data-line="13" class="code-line">
<li data-line="13" class="code-line">Dependabotだと同じ種類の依存関係でもPRが分離されPR数が多くなってしまい管理がしにくい。</li>
</ul>
</li>
<li data-line="14" class="code-line">特定のパッケージやモジュールのみを更新対象にしたり、週に一度だけPRを作成するように設定できる等カスタマイズしやすい。
<ul data-line="15" class="code-line">
<li data-line="15" class="code-line">Dependabotは、設定できるパラメータが限られており、Renovateほどの自由度がない。</li>
</ul>
</li>
<li data-line="16" class="code-line">テストやレビューが不要な場合、PRの作成からマージまでを完全に自動化できる。(DependabotだとCIをセットにしないとMergeまでやってくれない)
<ul data-line="17" class="code-line">
<li data-line="17" class="code-line">Dependabotは、更新後のコードがプロジェクトで正常に動作することを確認するためにCIでテストを実行する必要があるため。</li>
</ul>
</li>
</ul>
<h1 id="3.%E5%89%8D%E6%8F%90" data-line="19" class="code-line">
<a class="header-anchor-link" href="#3.%E5%89%8D%E6%8F%90" aria-hidden="true"></a> 3.前提</h1>
<ul data-line="20" class="code-line">
<li data-line="20" class="code-line">RenovateとGithubが連携済みであること 
<a href="https://github.com/apps/renovate" target="_blank" rel="nofollow noopener noreferrer">https://github.com/apps/renovate</a> 
<img src="https://res.cloudinary.com/zenn/image/fetch/s--j9ew_wVv--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_1200/https://storage.googleapis.com/zenn-user-upload/deployed-images/8c682c8509325a1266406f3f.png%3Fsha%3D75dab16ce7f80d71a2c96e031440e51892a5397b" loading="lazy" class="md-img">
</li>
</ul>
<aside class="msg message">!<div class="msg-content">
reference:<a href="https://qiita.com/ksh-fthr/items/40732b6396f36c62bea2" target="_blank" rel="nofollow noopener noreferrer">https://qiita.com/ksh-fthr/items/40732b6396f36c62bea2</a>
</div></aside>
<h1 id="4.renovate.json%E3%81%AE%E9%85%8D%E7%BD%AE" data-line="29" class="code-line">
<a class="header-anchor-link" href="#4.renovate.json%E3%81%AE%E9%85%8D%E7%BD%AE" aria-hidden="true"></a> 4.<code>renovate.json</code>の配置</h1>
<ul data-line="30" class="code-line">
<li data-line="30" class="code-line">基本的にはリポジトリの<code>ルートディレクトリ</code> or <code>.github</code>配下に配置します。 
ルートディレクトリが最優先されるので、特別に理由がない場合はルートディレクトリに配置します。 
<img src="https://res.cloudinary.com/zenn/image/fetch/s--AjDaEl69--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_1200/https://storage.googleapis.com/zenn-user-upload/deployed-images/6e86eeceec9f224d654a5902.png%3Fsha%3D32781ba285fe2c82bd3f72e699a83593d81e1302" loading="lazy" class="md-img">
</li>
</ul>
<h1 id="5.%E3%82%B3%E3%83%BC%E3%83%89%E3%81%A8%E3%83%91%E3%83%A9%E3%83%A1%E3%83%BC%E3%82%BF%E3%81%AE%E8%A7%A3%E8%AA%AC" data-line="34" class="code-line">
<a class="header-anchor-link" href="#5.%E3%82%B3%E3%83%BC%E3%83%89%E3%81%A8%E3%83%91%E3%83%A9%E3%83%A1%E3%83%BC%E3%82%BF%E3%81%AE%E8%A7%A3%E8%AA%AC" aria-hidden="true"></a> 5.コードとパラメータの解説</h1>
<ul data-line="35" class="code-line">
<li data-line="35" class="code-line">
バージョンアップしたい対象
<ul data-line="36" class="code-line">
<li data-line="36" class="code-line">terraformブロック</li>
<li data-line="37" class="code-line">
<code>.terraform-verison</code>ファイル</li>
<li data-line="38" class="code-line">providerブロック</li>
<li data-line="39" class="code-line">公式Module</li>
</ul>
</li>
<li data-line="41" class="code-line">
スコープ
<ul data-line="42" class="code-line">
<li data-line="42" class="code-line">Terraformのバージョン更新を自動で管理し、PR作成からMergeまでを自動化</li>
<li data-line="43" class="code-line">個人用のリポジトリのため、更新優先のためメジャーバージョンも対象</li>
</ul>
</li>
<li data-line="45" class="code-line">
備考
<ul data-line="46" class="code-line">
<li data-line="46" class="code-line">今回はCIテストをしなくても自動マージされるよう設定。</li>
<li data-line="47" class="code-line">RenovateのApprove用Botにレビュアーを対応させる。</li>
<li data-line="48" class="code-line">個人用のリポジトリのため、Majorバージョンも自動マージに対照しています。(業務であればMajorはレビューする必要あります。)</li>
</ul>
</li>
</ul>
<div class="code-block-container">
<div class="code-block-filename-container">takehiro1111/aws_terraform/renovate.json</div>
<pre class="language-json"><code class="language-json code-line" data-line="50">// 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"
 }
 ]
}

</code></pre>
</div><h3 id="%E4%B8%8A%E8%A8%98%E3%82%B3%E3%83%BC%E3%83%89%E3%81%AE%E7%B5%90%E6%9E%9C%E3%80%81%E3%83%90%E3%83%BC%E3%82%B8%E3%83%A7%E3%83%B3%E6%9B%B4%E6%96%B0%E3%82%92%E8%A1%8C%E3%81%84pr%E4%BD%9C%E6%88%90%E3%80%9Cmerge%E3%81%BE%E3%81%A7%E8%87%AA%E5%8B%95%E5%8C%96%E3%81%95%E3%82%8C%E3%82%8B%E3%80%82" data-line="88" class="code-line">
<a class="header-anchor-link" href="#%E4%B8%8A%E8%A8%98%E3%82%B3%E3%83%BC%E3%83%89%E3%81%AE%E7%B5%90%E6%9E%9C%E3%80%81%E3%83%90%E3%83%BC%E3%82%B8%E3%83%A7%E3%83%B3%E6%9B%B4%E6%96%B0%E3%82%92%E8%A1%8C%E3%81%84pr%E4%BD%9C%E6%88%90%E3%80%9Cmerge%E3%81%BE%E3%81%A7%E8%87%AA%E5%8B%95%E5%8C%96%E3%81%95%E3%82%8C%E3%82%8B%E3%80%82" aria-hidden="true"></a> 上記コードの結果、バージョン更新を行いPR作成〜Mergeまで自動化される。</h3>
<img src="https://res.cloudinary.com/zenn/image/fetch/s---2q_rO1W--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_1200/https://storage.googleapis.com/zenn-user-upload/deployed-images/7b656e58e194a0177cc4f049.png%3Fsha%3D160de27583c1c3f0e494d8169220e17134da67cb" loading="lazy" class="md-img"> 
<img src="https://res.cloudinary.com/zenn/image/fetch/s--aVW05XPu--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_1200/https://storage.googleapis.com/zenn-user-upload/deployed-images/b6f004cb09ee8c036ad28fbf.png%3Fsha%3D075df5657b21f604949c6337f51174858d3712a9" loading="lazy" class="md-img">
<h2 id="%E5%8F%82%E8%80%83" data-line="92" class="code-line">
<a class="header-anchor-link" href="#%E5%8F%82%E8%80%83" aria-hidden="true"></a> 参考</h2>
<iframe id="zenn-embedded__cf62894cbd424" src="https://embed.zenn.studio/card#zenn-embedded__cf62894cbd424" data-content="https%3A%2F%2Fdocs.renovatebot.com%2Fconfiguration-options%2F" frameborder="0" scrolling="no" loading="lazy"></iframe><a href="https://docs.renovatebot.com/configuration-options/" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://docs.renovatebot.com/configuration-options/</a> 
<iframe id="zenn-embedded__93c1c4d1cda58" src="https://embed.zenn.studio/card#zenn-embedded__93c1c4d1cda58" data-content="https%3A%2F%2Fqiita.com%2Fksh-fthr%2Fitems%2F40732b6396f36c62bea2" frameborder="0" scrolling="no" loading="lazy"></iframe><a href="https://qiita.com/ksh-fthr/items/40732b6396f36c62bea2" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://qiita.com/ksh-fthr/items/40732b6396f36c62bea2</a> 
<iframe id="zenn-embedded__1362d29f8362e" src="https://embed.zenn.studio/card#zenn-embedded__1362d29f8362e" data-content="https%3A%2F%2Finside.dmm.com%2Farticles%2Frenovate-dependency-management-automation%2F" frameborder="0" scrolling="no" loading="lazy"></iframe><a href="https://inside.dmm.com/articles/renovate-dependency-management-automation/" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://inside.dmm.com/articles/renovate-dependency-management-automation/</a> 
<iframe id="zenn-embedded__18ac29301efe5" src="https://embed.zenn.studio/card#zenn-embedded__18ac29301efe5" data-content="https%3A%2F%2Fwww.blogaomu.com%2Fentry%2Ftry-renovate-auto-merge" frameborder="0" scrolling="no" loading="lazy"></iframe><a href="https://www.blogaomu.com/entry/try-renovate-auto-merge" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://www.blogaomu.com/entry/try-renovate-auto-merge</a> 
<iframe id="zenn-embedded__48d5268637b19" src="https://embed.zenn.studio/card#zenn-embedded__48d5268637b19" data-content="https%3A%2F%2Fzenn.dev%2Fbook000%2Farticles%2Frenovate-dep-auto-update" frameborder="0" scrolling="no" loading="lazy"></iframe><a href="https://zenn.dev/book000/articles/renovate-dep-auto-update" style="display:none" target="_blank">https://zenn.dev/book000/articles/renovate-dep-auto-update</a>

TerraformをRenovateで自動バージョンアップし、PR作成とMergeを自動化する

上記コードの結果、バージョン更新を行いPR作成〜Mergeまで自動化される。

Discussion