Update Documentation #280
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# This workflow integrates Scan with GitHub's code scanning feature | |
# Scan is a free open-source security tool for modern DevOps teams from ShiftLeft | |
# Visit https://slscan.io/en/latest/integrations/code-scan for help | |
name: SL Scan | |
# This section configures the trigger for the workflow. Feel free to customize depending on your convention | |
on: | |
push: | |
branches: | |
- 'main' | |
pull_request: | |
branches: | |
- 'main' | |
workflow_dispatch: | |
jobs: | |
Scan-Build: | |
# Scan runs on ubuntu, mac and windows | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 #v4.1.7 | |
# Instructions | |
# 1. Setup JDK, Node.js, Python etc depending on your project type | |
# 2. Compile or build the project before invoking scan | |
# Example: mvn compile, or npm install or pip install goes here | |
# 3. Invoke Scan with the github token. Leave the workspace empty to use relative url | |
- name: Set up Python | |
uses: actions/setup-python@39cd14951b08e74b54015e9e001cdefcf80e669f #v5.1.1 | |
with: | |
python-version: '3.12.4' # Version range or exact version of a Python version to use, using SemVer's version range syntax | |
architecture: 'x64' # optional x64 or x86. Defaults to x64 if not specified | |
- name: Install Dependencies | |
run: | | |
python -m pip install --upgrade-strategy eager --upgrade pip | |
python -m pip install --upgrade -r app/requirements.txt | |
- name: Perform Scan | |
uses: ShiftLeftSecurity/scan-action@54980bbdae434b8e7903cfcffa98a2601c207962 #v1.3.0 | |
env: | |
WORKSPACE: "" | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
SCAN_AUTO_BUILD: true | |
with: | |
output: reports | |
# Scan auto-detects the languages in your project. To override uncomment the below variable and set the type | |
# type: credscan,java | |
# type: python | |
- name: Upload report | |
uses: github/codeql-action/upload-sarif@9b7c22c3b39078582fa6d0d8f3841e944ec54582 #v2.17.6 | |
with: | |
sarif_file: reports |