feat: test checkov github-action in public module #10
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
| --- | |
| name: checkov | |
| # Controls when the workflow will run | |
| on: | |
| # Triggers the workflow on worflow call request events. | |
| pull_request: | |
| inputs: | |
| directory: | |
| required: true | |
| type: string | |
| continue_on_error: | |
| required: true | |
| type: string | |
| default: 'true' | |
| var_file: | |
| required: false | |
| type: string | |
| # A workflow run is made up of one or more jobs that can run sequentially or in parallel | |
| jobs: | |
| # This workflow contains a single job called "scan" | |
| scan: | |
| permissions: | |
| contents: read # for actions/checkout to fetch code | |
| security-events: write # - for github/codeql-action/upload-sarif to upload SARIF results | |
| actions: read # - only required for a private repository by github/codeql-action/upload-sarif to get the Action run status | |
| # The type of runner that the job will run on | |
| runs-on: ubuntu-latest | |
| # Steps represent a sequence of tasks that will be executed as part of the job | |
| steps: | |
| # Checks-out your repository under $GITHUB_WORKSPACE, so follow-up steps can access it | |
| - uses: actions/checkout@v4 | |
| - name: Checkov GitHub Action | |
| if: ${{ inputs.continue_on_error == 'true' }} | |
| uses: bridgecrewio/checkov-action@v12 | |
| with: | |
| # This will add both a CLI output to the console and create a results.sarif file | |
| output_format: cli,sarif | |
| output_file_path: console,results.sarif | |
| soft_fail: true | |
| directory: ${{ inputs.directory}} | |
| var_file: ${{ inputs.var_file}} | |
| - name: Checkov GitHub Action | |
| if: ${{ inputs.continue_on_error == 'false' }} | |
| uses: bridgecrewio/checkov-action@v12 | |
| with: | |
| # This will add both a CLI output to the console and create a results.sarif file | |
| output_format: cli,sarif | |
| output_file_path: console,results.sarif | |
| directory: ${{ inputs.directory}} | |
| var_file: ${{ inputs.var_file}} | |
| - name: Upload SARIF file | |
| uses: github/codeql-action/upload-sarif@v3 | |
| # Results are generated only on a success or failure | |
| # This is required since GitHub by default won't run the next step | |
| # when the previous one has failed. Security checks that do not pass will 'fail' | |
| # An alternative is to add `continue-on-error: true` to the previous step | |
| # Or 'soft_fail: true' to checkov | |
| if: success() || failure() | |
| with: | |
| sarif_file: results.sarif | |
| ... |