Aikido CLIのGitHub Actionセットアップ: Release Gating

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

1. APIトークンの取得

Continuous Integration Settingsページに移動します。
トークンを生成してコピーします。このトークンは一度しか表示されない点に注意してください。
Settings > Secrets and variables > Actionsに移動し、このトークンをAIKIDO_CLIENT_API_KEYとしてGitHub Secretsに保存します。

2. 新しいGitHub Actionワークフローの作成

次の例を使ってワークフローファイルを作成します。

local scannerがデフォルトブランチに対してのみトリガーされるようにしてください。以下の例では ‘main’ ブランチです。必要に応じて調整してください。

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

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

    steps:
      # Step 1: Set up Node.js
      - name: Set up Node.js
        uses: actions/setup-node@v3
        with:
          node-version: '22'

      # Step 2: Install dependencies
      - name: Install Aikido CI API Client
        run: npm install --global @aikidosec/ci-api-client

      # Step 3: Run Aikido Scan Release
      - name: Run 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. 最初のスキャンを実行する

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