Skip to content

Validation Configuration

Jump to bottom
Hekku2 edited this page Apr 1, 2020 · 5 revisions

Repository Validation Configuration guide

Repository validator configuration.

Using a web configuration or similar, it is possible to use environment variables to disable certain rules. To disable a rule r, set an environment variable as Rules:*r* to disable. For example, to disable rule HasLicenseRule, set Rules:HasLicenseRule as disable.

All rules are enabled by default. Only set environment variables to disable rules.

Other repositories

Each individual repository may contain a repository-validator.json file which can be used to configure the way that the repository is validated. Currently, it can be used to ignore certain rules by adding the class name to an IgnoredRules array.

Example repository-validator.json file which ignores 4 rules.

{
    "Version": "1",
    "IgnoredRules": [
        "HasDescriptionRule",
        "HasNewestPtcsJenkinsLibRule",
        "HasReadmeRule"
        "HasLicenseRule"
    ]
}

Rules contains specific details for each available rule.

Clone this wiki locally