|
| 1 | +# This workflow uses actions that are not certified by GitHub. |
| 2 | +# They are provided by a third-party and are governed by |
| 3 | +# separate terms of service, privacy policy, and support |
| 4 | +# documentation. |
| 5 | + |
| 6 | +# A sample workflow which sets up Snyk to analyze the full Snyk platform (Snyk Open Source, Snyk Code, |
| 7 | +# Snyk Container and Snyk Infrastructure as Code) |
| 8 | +# The setup installs the Snyk CLI - for more details on the possible commands |
| 9 | +# check https://docs.snyk.io/snyk-cli/cli-reference |
| 10 | +# The results of Snyk Code are then uploaded to GitHub Security Code Scanning |
| 11 | +# |
| 12 | +# In order to use the Snyk Action you will need to have a Snyk API token. |
| 13 | +# More details in https://github.com/snyk/actions#getting-your-snyk-token |
| 14 | +# or you can signup for free at https://snyk.io/login |
| 15 | +# |
| 16 | +# For more examples, including how to limit scans to only high-severity issues |
| 17 | +# and fail PR checks, see https://github.com/snyk/actions/ |
| 18 | + |
| 19 | +name: Snyk Security |
| 20 | + |
| 21 | +on: |
| 22 | + push: |
| 23 | + branches: ["main", "staging"] |
| 24 | + pull_request: |
| 25 | + branches: ["main", "staging"] |
| 26 | + |
| 27 | +permissions: |
| 28 | + contents: read |
| 29 | + |
| 30 | +jobs: |
| 31 | + snyk: |
| 32 | + continue-on-error: true |
| 33 | + permissions: |
| 34 | + contents: read # for actions/checkout to fetch code |
| 35 | + security-events: write # for github/codeql-action/upload-sarif to upload SARIF results |
| 36 | + actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status |
| 37 | + runs-on: ubuntu-latest |
| 38 | + |
| 39 | + env: |
| 40 | + # This is where you will need to introduce the Snyk API token created with your Snyk account |
| 41 | + SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }} |
| 42 | + |
| 43 | + steps: |
| 44 | + - uses: actions/checkout@v4 |
| 45 | + - name: Set up Snyk CLI to check for security issues |
| 46 | + # Snyk can be used to break the build when it detects security issues. |
| 47 | + # In this case we want to upload the SAST issues to GitHub Code Scanning |
| 48 | + uses: snyk/actions/setup@806182742461562b67788a64410098c9d9b96adb |
| 49 | + |
| 50 | + # For Snyk Open Source you must first set up the development environment for your application's dependencies |
| 51 | + # For example for Node |
| 52 | + #- uses: actions/setup-node@v4 |
| 53 | + # with: |
| 54 | + # node-version: 20 |
| 55 | + |
| 56 | + # Runs Snyk Code (SAST) analysis and uploads result into GitHub. |
| 57 | + # Use || true to not fail the pipeline |
| 58 | + - name: Snyk Code test |
| 59 | + run: snyk code test --sarif > snyk-code.sarif |
| 60 | + continue-on-error: true |
| 61 | + |
| 62 | + # Runs Snyk Open Source (SCA) analysis and uploads result to Snyk. |
| 63 | + - name: Snyk Open Source monitor |
| 64 | + run: snyk monitor --all-projects |
| 65 | + |
| 66 | + # Disabled because this repo does not use IaC or Docker yet |
| 67 | + |
| 68 | + # # Runs Snyk Infrastructure as Code (IaC) analysis and uploads result to Snyk. |
| 69 | + # # Use || true to not fail the pipeline. |
| 70 | + # - name: Snyk IaC test and report |
| 71 | + # run: snyk iac test --report # || true |
| 72 | + |
| 73 | + # # Build the docker image for testing |
| 74 | + # - name: Build a Docker image |
| 75 | + # run: docker build -t your/image-to-test . |
| 76 | + # # Runs Snyk Container (Container and SCA) analysis and uploads result to Snyk. |
| 77 | + # - name: Snyk Container monitor |
| 78 | + # run: snyk container monitor your/image-to-test --file=Dockerfile |
| 79 | + |
| 80 | + # Push the Snyk Code results into GitHub Code Scanning tab |
| 81 | + - name: Upload result to GitHub Code Scanning |
| 82 | + uses: github/codeql-action/upload-sarif@v3 |
| 83 | + with: |
| 84 | + sarif_file: snyk-code.sarif |
0 commit comments