Generate GitHub Steampipe Report
note
Steampipe Report Actions are only available on private runners.
Background
The Generate GitHub Steampipe Report Action performs Steampipe checks on GitHub resources and generates a report. The checks are performed using GitHub benchmarks/controls for supported mods.
A full description of all supported mods is provided here:
- GitHub Compliance - version 0.3
- GitHub Sherlock - version 0.9
Action Parameters
| Parameter | Description |
|---|---|
| Steampipe Mod | The steampipe mod to run. |
| Benchmark | The name of the selected mod benchmark (or control) to run. |
| File Identifier | The identifier of the report file to create. Leave empty to get the report as the step output. |
| Output Format | Representation of the output result. |
| Variables | Specify parameters for running the benchmark by adding a new variable with a name and value. |
Using Variables
To understand how to add variables, consider the following example from the Steampipe CLI:
steampipe check github_compliacne.benchmark.cis_supply_chain_v100_1_2 --var 'trusted_issue_admins=["some_user"]'
From this example, you can see that the variable trusted_issue_admins has a value of ["some_user"].
To add this variable in the form, enter trusted_issue_admins in the "Name" column and ["some_user"] in the "Value" column.
