Repository validation
This is where the validation rules that run against the various repository categories live.
Structure
- There is one file pr. rule.
- All rule needs tests to verify every possible outcome for the rule.
- It's better with multiple files than a big rule.
- All rules uses
ValidationBaseorActionValidationBaseas the base class. - The
ActionValidationBaseare for checks that will breaks compatibility with with existing repositories (default), so these are only run in github actions. - Only use
validateorasync_validatemethods to define validation rules. - If a rule should fail, raise
ValidationExceptionwith the failure message.
Example
from .base import (
ActionValidationBase,
ValidationBase,
ValidationException,
)
class AwesomeRepository(ValidationBase):
def validate(self):
if self.repository != "awesome":
raise ValidationException("The repository is not awesome")
class SuperAwesomeRepository(ActionValidationBase):
category = "integration"
async def async_validate(self):
if self.repository != "super-awesome":
raise ValidationException("The repository is not super-awesome")