This is an early build of the site and information may not be accurate or complete.
GitHub Actions

This collector collect builds from GitHub Actions.

Example

{
    "$schema": "https://duckhq.org/schema.json",
    "collectors": [
        {
            "github": {
                "id": "github_pullrequests",
                "owner": "duckhq",
                "repository": "duck",
                "workflow": "pull_request.yml",
                "credentials": {
                    "basic": {
                        "username": "patriksvensson",
                        "password": "hunter1!"
                    }
                }
            }
        }
    ]
}

Required fields

Field Type Description
credentials AzureDevOpsCredentials The GitHub credentials
id String The GitHub collector ID
owner String The GitHub owner
repository String The GitHub repository
workflow String The GitHub Actions workflow

Optional fields

Field Type Description
enabled Boolean Determines whether or not this collector is enabled

Credentials

The credentials fields is where you tell Duck how you want to authenticate with GitHub.

Basic authentication:

"credentials": {
    "basic": {
        "username": "patriksvensson",
        "password": "hunter1!"
    }
}