Dependabot でアクションを最新に保つ

Dependabot version updates のアクションについて

多くの場合、アクションはバグ修正と新機能で更新され、自動プロセスの信頼性、速度、安全性が向上しています。 GitHub Actions に対して Dependabot version updates を有効にすると、Dependabot では、リポジトリの workflow.yml ファイル内のアクションへのリファレンスとワークフロー内で使用される再利用可能なワークフローが最新の状態に保たれるようにします。

Dependabot では、ファイル内のアクションごとに、アクションのリファレンス (通常、アクションに関連付けられているバージョン番号またはコミット ID) が最新バージョンと参照されます。アクション作成者がアクションのバージョンを管理する方法については、「カスタムアクションにリリース管理を使用する」を参照してください。

より新しいバージョンのアクションが使用可能な場合、Dependabot によって、ワークフローファイル内のリファレンスを最新バージョンに更新する pull request が送信されます。 Dependabot version updates の詳細については、「GitHub Dependabot のバージョンアップデートについて」を参照してください。 GitHub Actions のワークフローの構成の詳細については、「ワークフローの書き込み」を参照してください。

Dependabot では、ワークフローファイルで再利用可能なワークフローの使用もチェックされ、再利用可能なワークフローと呼ばれるこれらの Git リファレンスが更新されます。再利用可能なワークフローについて詳しくは、「ワークフローの再利用」を参照してください。

メモ

Dependabot pull request によってトリガーされるワークフロー実行は、フォークされたリポジトリからのものであるかのように実行されるため、読み取り専用の GITHUB_TOKEN を使用します。それらのワークフローの実行は、シークレットにはアクセスできません。これらのワークフローをセキュリティで保護するための戦略については、「GitHub Actions のセキュリティ強化」を参照してください。

Dependabot version updates のアクションを有効化する

自分のアクションと、依存するライブラリとパッケージを維持するように Dependabot version updates を構成できます。

他のエコシステムまたはパッケージマネージャーで既に Dependabot version updates を有効にしている場合は、既存の dependabot.yml ファイルを開くだけです。それ以外の場合、リポジトリの .github ディレクトリに dependabot.yml 構成ファイルを作成します。詳しくは、「Dependabot のバージョンアップデートの設定」をご覧ください。
"github-actions" を package-ecosystem として指定して監視します。
directory を "/" に設定して、.github/workflows でワークフローファイルを確認します。
schedule.interval を設定して、新しいバージョンを確認する頻度を指定します。
リポジトリの .github ディレクトリにある dependabot.yml 構成ファイルを確認します。既存のファイルを編集した場合は、変更を保存します。

フォークで Dependabot version updates を有効化することもできます。詳しくは、「Dependabot のバージョンアップデートの設定」をご覧ください。

GitHub Actions

の dependabot.yml ファイルの例

次の dependabot.yml ファイルの例では、GitHub Actions のバージョン更新を設定しています。 .github/workflows でワークフローファイルを確認するために、directory は "/" に設定する必要があります。 schedule.interval に "weekly" が設定されています。このファイルがチェックインまたは更新されると、Dependabot はアクションの新しいバージョンをチェックします。 Dependabot では、検出した期限切れのアクションに対してバージョン更新の pull request が生成されます。初期バージョンの更新後、Dependabot では 1 週間に 1 回、期限切れのバージョンのアクションを引き続き確認します。

YAML

# Set update schedule for GitHub Actions

version: 2
updates:

  - package-ecosystem: "github-actions"
    directory: "/"
    schedule:
      # Check for updates to GitHub Actions every week
      interval: "weekly"

# Set update schedule for GitHub Actions

version: 2
updates:

  - package-ecosystem: "github-actions"
    directory: "/"
    schedule:
      # Check for updates to GitHub Actions every week
      interval: "weekly"

Dependabot version updates のアクションを設定する

アクションに対して Dependabot version updates を有効にする場合は、package-ecosystem、directory、schedule.interval の値を指定する必要があります。バージョン更新をさらにカスタマイズするための設定オプションのプロパティは他にもたくさんあります。詳しくは、「Dependabot オプションリファレンス」をご覧ください。

参考資料

ワークフローの書き込み