Aikido CLI: リリースゲーティングのGitHub Actions設定

Aikido Security CIクライアントを使用すると、Aikido SecurityのスキャンをCIパイプラインに統合できます。セキュリティスキャンをビルドプロセスの一部にできます。

1. APIトークンを取得する

1. へ移動 継続的インテグレーション設定ページ.
2. トークンを生成してコピーします。このトークンは一度しか表示できないことに注意してください。
3. このトークンを次の名前で保存します AIKIDO_CLIENT_API_KEY GitHub Secrets の Settings > Secrets and variables > Actions へ移動して設定してください。

2. 新しい GitHub Actions ワークフローを作成する

この例を使ってワークフローファイルを作成してください:

ローカルスキャナーがデフォルトブランチでのみ起動されるようにしてください。以下の例では、それは 'main' ブランチです。必要に応じて調整してください。

name: Aikido Release Gated Scan
on:
  push:
    branches:
      - main

jobs:
  aikido-scan:
    runs-on: ubuntu-latest

    steps:
      # ステップ 1: Node.js をセットアップ
      - name: Node.js をセットアップ
        uses: actions/setup-node@v3
        with:
          node-version: '22'

      # ステップ 2: 依存関係をインストール
      - name: Aikido CI API Client をインストール
        run: npm install --global @aikidosec/ci-api-client

      # ステップ 3: Aikido Scan Release を実行
      - name: Aikido Scan を実行
        run: aikido-api-client scan-release ${{ github.event.repository.name }} $GITHUB_SHA --apikey ${{ secrets.AIKIDO_CLIENT_API_KEY }} --fail-on-sast-scan --fail-on-iac-scan --fail-on-secrets-scan

必要に応じてコマンドを調整してください。すべてのオプションは こちら.

3. 最初のスキャンを実行する

新しい変更がデフォルトブランチにプッシュされると、ワークフローがトリガーされます。スキャンが実行され、新しい問題が検出された場合は失敗します。