kakudooo docs

Renovateについて調べた基本的な内容と、導入や設定をする中で事前に知っておきたかったことを備忘として残しておく。

Renovateとは？

Automated dependency updates. Multi-platform and multi-language.

複数のプラットフォームや言語に対応した、依存更新の自動化ツール。

• 対応プラットフォーム
• 対応言語

Renovateの使いどころ

ユースケースとしては、以下の2点

• Development dependency updates: 依存関係の更新
• DevOps tooling: DevOpsツール

参照: https://docs.renovatebot.com/getting-started/use-cases/

Development dependency updates

• パッケージファイルの更新
  • npm: package.json
  • bundler: Gemfile
  • など
• lock fileの更新
  • npm: package-lock.json
  • bundler: Gemfile.lock
  • など
• 依存関係の抽出方法をカスタマイズでき、それをRenovateから使える
  • Renovateによる更新の対象にしたいpackage managerやファイルのフォーマットがサポートされていない場合など

パッケージファイルの更新の仕組み

1. パッケージファイルとその依存を見つけるためにリポジトリ内を走査する
2. 新しいバージョンが存在するかどうかを確認する
3. 利用可能なアップデートをPull Requestとして作成する

デフォルトだと、以下の設定になっている

• 依存関係毎にPull Requestを分割する
• メジャーバージョンのアップデートはメジャーバージョン以外のアップデートとは分けられる

lock fileの更新の仕組み

lock fileは、Package managerの実行によって更新される。(Renovate自体にはlock fileを作成する機能はないため)

以下は、例

1. リポジトリにpackage.jsonとpackage-lock.jsonがあり、ある依存モジュールがversion 1.0.0だとする
2. そのモジュールの1.1.0が利用可能になる
3. Renovateはまずpackage.jsonのバージョン指定を変更する
4. npm installを実行する
5. npmが依存関係を解決し、package-lock.jsonを更新する
6. Renovateは両方のファイルをコミットしてPull Requestを作成する

DevOps tooling

• DevOps/Infrastructure as Codeツールのアップデート
  • Docker, k8s, Terraformなどの構成ファイルに記述されている依存関係の更新
• 内部パッケージの更新
  • 社内リポジトリの依存関係の更新を外部OSSのように扱える

RenovateとDependabotの違い

Dependabot

GitHub製のツールなので、GitHub上の機能として動作するところが売り。依存関係の更新ツールとしての機能はシンプル。

Renovate

Dependency Dashboard, Grouping機能, 対応Platformの多さ, カスタマイズ性など、コミュニティーベースで作られているからこその機能の豊富さが売り。

詳細な機能の比較はこちらを参照。

Renovateのはじめ方

実行環境の選択肢

以下の3種類の選択肢が提供されている。

• Mend Renovate Appを使う
• Renovateをセルフホストして使う
• 第三者がホストしているRenovateをインストールして使う

参照: https://docs.renovatebot.com/getting-started/running/#running-renovate

リポジトリへのインストールと設定

Mend Renovate App (Mend社が提供するRenovateのホスティングサービス)を使うことで、セルフホストの手間を省いて使用を開始できる。 導入環境や構成によってセルフホストする必要があるかもしれないが、特に制約がなければまずはMend Renovate Appから使い始めてみるとよい。

• セルフホストへの移行事例 Renovateをメモリ不足なクラウド版から、GitHub ActionsのSelf-host版へ移行した

インストールと設定の方法については、以下の公式ドキュメントを参照。

Installing and onboarding Renovate into repositories

最初に知っておくとよいこと

公式 I don’t know where to start + α

• config:recommended presetをとりあえず使う
  • config:recommendedに含まれる設定は一通り確認しておく
• renovate.jsonのデバッグ方法
  • Renovateの設定をローカル環境でデバッグする方法
• Dependency Dashboardが作成されているかの確認
  • Renovateによる依存更新の状態を可視化するダッシュボード
    • GitHubであれば、issueとして作成される
    • すでに作成されたPull Requestや、作成待ちの依存更新のリストが表示される
  • dependencyDashboard optionをtrueにすることで作成される
    • config:recommended presetを使用していれば有効化されている
• 既存のPull Requestに対してRenovateを手動で再実行する方法
  • Pull RequestのIf you want to rebase/retry this PR, check this boxにチェックを入れる
  • rebaseした上で再度Renovateを実行したい場合などに使用する
    • 例えば、renovate.jsonの定義内容を変更後、再度そのPull Requestに対してRenovateを実行したい場合
  • https://docs.renovatebot.com/updating-rebasing/
• 初心者向けのReading Listを読んでおく
  • https://docs.renovatebot.com/reading-list/#beginners