Skip to main content

GitHub

GitHub Actions

The GitHub Actions scraper creates configuration items from GitHub Actions workflows. Specify the owner, repository, and branch to scrape.

github-actions.yaml
apiVersion: configs.flanksource.com/v1
kind: ScrapeConfig
metadata:
name: github-actions-scraper
spec:
githubActions:
- owner: flanksource
repository: config-db
connection: connection://default/github-pat
branch: main

GitHub Repository

The GitHub Repository scraper creates GitHub::Repository config items and optionally fetches security alerts (Dependabot, code scanning, secret scanning) and OpenSSF Scorecard data as analyses.

FieldDescriptionSchemeRequired
repositoriesList of repositories to scrape[]GitHubRepositorytrue
personalAccessTokenPersonal access token for authentication[]EnvVar
connectionConnection name for GitHub credentialstring
securityEnable Dependabot, code scanning, and secret scanning alertsbool
openssfEnable OpenSSF Scorecard databool
securityFiltersFilters for security alertsSecurityFilters

GitHubRepository

FieldDescriptionSchemeRequired
ownerGitHub repository ownerstringtrue
repoGitHub repository namestringtrue

SecurityFilters

FieldDescriptionScheme
severityFilter alerts by severity (e.g. critical, high)[]string
stateFilter alerts by state (e.g. open, fixed)[]string
maxAgeOnly include alerts newer than this duration (e.g. 7d, 24h)string