LB014#

class src.ansys.pre_commit_hooks.quality_rules.labels.LB014#

Bases: Labels

Labeler.yml labels documentation and workflow changes.

Overview#

check

Check that file globs match documentation and workflow files.

Import detail#

from src.ansys.pre_commit_hooks.quality_rules.labels import LB014

Method detail#

static LB014.check(repository_root: pathlib.Path, readme_file: str | None) → ansys.pre_commit_hooks.quality_rules.common.RuleCheckResult#

Check that file globs match documentation and workflow files.

Returns:
bool or str

True when globs match both doc/source/index.rst and .github/workflows/ci_cd.yml, otherwise a "RECOMMENDATION: ..." message naming the uncovered changes.