security-report-action/action.yml at main · advanced-security/security-report-action · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
name: GitHub Security Report Action
description: Generates security reports for a GitHub repository
author: Peter Murray

inputs:
  token:
    description: GitHub Access Token with permissions for securoty events access on the repository.
    default: ${{ github.token }}

  outputDir:
    description: The output directory for the generated report(s).
    required: true
    default: ${{ github.workspace }}

  repository:
    description: Repository name with owner. For example, peter-murray/github-security-report
    required: true
    default: ${{ github.repository }}

  sarif_report_id:
    description: The latest SARIF report id to use for the analysis of the code scanning results, if not specified the latest report will be used for the target ref.
    required: false

  ref:
    description: The ref for the target to get the code scanning findings for
    required: true
    default: ${{ github.ref }}

  sha:
    description: The SHA of the HEAD of the ref for the scanning results
    required: true
    default: ${{ github.sha }}

  report_template:
    description: The template to use for the report being generated
    required: false
    default: summary

  include_code_scanning:
    description: Include code scanning data in the report
    required: false
    default: true

  include_secret_scanning:
    description: Include secret scanning data in the report
    required: false
    default: true

  include_software_composition_analysis:
    description: Include software compositiona analysis data in the report
    required: false
    default: true

runs:
  using: node20
  main: dist/index.js

branding:
  icon: shield
  color: green