ConceptsConfigurationManual Checks

Manual checks

Manual checks are a special type of check that is not automatically evaluated by the badge API. Instead, the result of the check is provided by a JSON file that is hosted on a server reachable by the Badge API Instance. The JSON file contains a list of granted projects or a regex pattern for granted projects.

You can provide a GitLab personal access token via the environment variable GITLAB_TOKEN to access a private repository where the JSON file is stored.

manual-check.json
{
    "granted": [],
    "grantedRegex": [
        "^https://gitlab\\.opencode\\.de.*"
    ]
}

The file is referenced in the .badge-api.yaml configuration file of the badge. See more details about the configuration file.

Configuration FileOverview