CI 設定例-GitHub Actions

ここでは、CI 設定例として、GitHub Actions をご紹介します。

GitHub Actions について詳しく知りたい方は GitHub Actions 公式ドキュメントをご参照ください。

前提

• GitHub のアカウント登録とリポジトリ登録は完了しているものとします。
• 本設定例では、yarn プロジェクトのスキャンを題材にしております。
• プロジェクトグループ識別キーには yamory_scan_sample を使用しております。参考にする際は適宜読み替えてください。
• コマンドラインスキャンの項より、実行するコマンドは事前に取得しておいてください。
• YAMORY_API_KEY の設定には、 GitHub 上のシークレットを使用しております。本設定例では設定方法を割愛しますので、GitHub のシークレットの定義は以下をご確認ください。

暗号化されたシークレット - GitHub Docs

全体の流れ

本設定例では、リポジトリの main ブランチにマージまたはコミットした際、yamory のコマンドラインスキャンを実行する方法を説明します。

1. コマンドラインスキャンのコマンドを編集する。
2. GitHub Actions の定義ファイルを準備する。
3. main ブランチにマージまたはコミットする。

コマンドラインスキャンのコマンドを編集する

GitHub のシークレットを利用するため、事前に準備した実行するコマンドラインスキャンのコマンドから YAMORY_API_KEY を取り除きます。