GitHub에 Snyk 자동 실행 설정

깃헙에 파일을 main 브랜치에 푸시할 때마다 Snyk 보안 검사가 자동으로 실행되도록 설정하려면, 해당 프로젝트에 GitHub Action workflow를 만들어야 한다.

 

1. GitHub Actions Workflow 파일 만들기

1) 프로젝트 안에 workflows라는 새로운 폴더를 만들고 YAML 파일을 생성한다.

mkdir -p .github/workflows
touch .github/workflows/snyk-security.yml

 

2) YAML 파일의 내용 예시는 다음과 같다.

name: Snyk Security Scan
 
on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main
 
jobs:
  security:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
 
      - name: Set up Node.js
        uses: actions/setup-node@v4
        with:
          node-version: 18
 
      - name: Install dependencies
        run: npm install
 
      - name: Run Snyk Security Scan
        uses: snyk/actions/node@master
        with:
          command: test
        env:
          SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}

 

2. 깃헙 secret 생성

1) Snyk에서 API 토큰을 생성한다.

2) 깃헙으로 돌아가, Settings → Secrets and variables → Actions → New repository secret으로 이동
3) 새로운 secret을 만들고 복사한 토큰을 value에 붙여넣는다.

        Name: SNYK_TOKEN

        Value: (Paste your Snyk API token)

 

3. 깃헙으로 푸시

준비가 완료되었으면, 새로 생성된 Workflow 파일을 포함한 프로젝트를 커밋 후, main 브릿지로 푸시한다.

git add .github/workflows/snyk-security.yml
git commit -m "Add Snyk security scan workflow"
git push origin main

 

4. 확인

1) 깃헙의 해당 리파지토리로 가서 Actions로 이동

2) “Snyk Security Scan”가 작동되는 것을 확인

 

차후 단계?
Snyk 규칙을 개인화하기