GitHub Actions で、Poetry を使用しているプロジェクトに対して Snyk を適用する

はじめに

• この記事では、GitHub Actions で、Poetry を使用しているプロジェクトに対して Snyk を適用する方法について、メモとして残します。

適用手順

Auth Token の設定

• https://app.snyk.io/account から Auth Token を取得し、GitHub の Secret に、例えば SNYK_TOKEN として設定する。

ワークフローの作成

• snyk/actions/python@master の args の --file に、poetry.lock のパスを設定する。

.github/workflows/backend-test.yml

name: backend-test
on:
  push:
    paths: backend/**
jobs:
  test:
    runs-on: ubuntu-22.04
    steps:
      - name: sparse checkout
        uses: actions/checkout@v3
        with:
          sparse-checkout: |
            backend
      - name: snyk
        uses: snyk/actions/python@master
        env:
          SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
        with:
          command: test
          args: --severity-threshold=critical --file=backend/poetry.lock

参考

• https://docs.snyk.io/integrate-with-snyk/snyk-ci-cd-integrations/github-actions-for-snyk-setup-and-checking-for-vulnerabilities/snyk-python-action