> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blinkops.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Generate GitHub Steampipe Report

<Note>
  Steampipe Report Actions are only available on private runners.
</Note>

## Background[​](#background "Direct link to Background")

The *Generate GitHub Steampipe Report* Action performs [Steampipe checks](https://steampipe.io/docs/check/overview) 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](https://hub.steampipe.io/mods/turbot/github_compliance/controls) - version 0.3
* [GitHub Sherlock](https://hub.steampipe.io/mods/turbot/github_sherlock/controls) - version 0.9

## Action Parameters[​](#action-parameters "Direct link to 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[​](#using-variables "Direct link to 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.

<img src="https://mintcdn.com/blinkops-2/deay2AiePWJDKGEh/img/Actions/Steampipe/GenerateGitHubSteampipeReport.png?fit=max&auto=format&n=deay2AiePWJDKGEh&q=85&s=7df37bee30680867fde0d67fbfc60192" alt="RunAWSCloudQuery" width="1752" height="768" data-path="img/Actions/Steampipe/GenerateGitHubSteampipeReport.png" />
