Adds Contrast Scan workflow

2022-06-09 12:52:18 +01:00
parent d7a0d84297
commit a54c80f225
3 changed files with 66 additions and 0 deletions
@@ -0,0 +1,43 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+# This workflow will initiate a Contrast Scan on your built artifact, and subsequently upload the results SARIF to Github.
+
+# Pre-requisites: 
+# All Contrast related account secrets should be configured as GitHub secrets to be passed as inputs to the Contrast Scan Action.
+# The required secrets are CONTRAST_API_KEY, CONTRAST_ORGANIZATION_ID and CONTRAST_AUTH_HEADER.
+
+on:
+  push:
+    branches: [ $default-branch, $protected-branches ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ $default-branch ]
+  schedule:
+    - cron: $cron-weekly
+
+name: Scan analyze workflow
+jobs:
+  build-and-scan:
+    runs-on: ubuntu-latest
+    # check out project
+    steps:
+    - uses: actions/checkout@v3
+    # Since Contrast Scan is designed to run against your deployable artifact, the steps to build your artifact should go here.
+    # -name: Build Project
+    # ...
+    # Scan Artifact    
+    - name: Contrast Scan Action
+      uses: Contrast-Security-OSS/contrastscan-action@092c4e12ee0ee37b6116275f06efea84b2fe9d1a
+        with:
+          artifact: mypath/target/myartifact.jar # replace this path with the path to your built artifact
+          apiKey: ${{ secrets.CONTRAST_API_KEY }}
+          orgId: ${{ secrets.CONTRAST_ORGANIZATION_ID }}
+          authHeader: ${{ secrets.CONTRAST_AUTH_HEADER }}
+    #Upload the results to GitHub      
+    - name: Upload SARIF file
+      uses: github/codeql-action/upload-sarif@v2
+      with:
+        sarif_file: results.sarif # The file name must be 'results.sarif', as this is what the Github Action will output