The labels.py module#
Summary#
GitHub label rule family. |
|
The .github/labeler.yml file exists. |
|
The .github/labels.yml file exists. |
|
Labels.yml has a bug label. |
|
Labels.yml has an enhancement label. |
|
Labels.yml has a documentation label. |
|
Labeler.yml maps labels to match rules. |
|
Labeler.yml only assigns labels declared in labels.yml. |
|
Labels.yml has no duplicate labels. |
|
Labels.yml labels have a valid color. |
|
Labels.yml labels have a description. |
|
Labels.yml has a dependencies label. |
|
Labels.yml has ci, tests, maintenance, and release labels. |
|
Labels.yml has a good first issue label. |
|
Labeler.yml labels documentation and workflow changes. |
|
A workflow syncs labels.yml to GitHub. |
|
No legacy .yaml label files remain. |
Description#
GitHub label configuration checks.
This rule set validates the label files used by the PyAnsys labeler
workflows: .github/labels.yml declares the repository labels and
.github/labeler.yml assigns them to pull requests.
The checks cover:
Both files exist, and
.github/labeler.ymlis a mapping of labels to match rulesEvery label assigned by
.github/labeler.ymlis declared in.github/labels.ymlDeclared labels are unique and have a valid color and a description
The
bug,enhancement,documentation,dependencies,ci,tests,maintenance,release, andgood first issuelabels are declared.github/labeler.ymllabels documentation and workflow changesA workflow synchronizes the declared labels with GitHub
No legacy
.yamlcopies of the label files remain
Label names are compared case-insensitively, as GitHub does. Both files are
parsed with yaml.BaseLoader, so every scalar, including colors such
as 000000, is read as a string. Missing, unreadable, or invalid
configuration is reported as an ERROR.