hmetzner 9cec9e1a18 first commit 3 年 前
..
README.md 9cec9e1a18 first commit 3 年 前
__init__.py 9cec9e1a18 first commit 3 年 前
archived.py 9cec9e1a18 first commit 3 年 前
base.py 9cec9e1a18 first commit 3 年 前
brands.py 9cec9e1a18 first commit 3 年 前
description.py 9cec9e1a18 first commit 3 年 前
hacsjson.py 9cec9e1a18 first commit 3 年 前
images.py 9cec9e1a18 first commit 3 年 前
information.py 9cec9e1a18 first commit 3 年 前
integration_manifest.py 9cec9e1a18 first commit 3 年 前
issues.py 9cec9e1a18 first commit 3 年 前
manager.py 9cec9e1a18 first commit 3 年 前
topics.py 9cec9e1a18 first commit 3 年 前

README.md

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 ActionValidationBase as the base class.
  • Only use validate or async_validate methods to define validation rules.
  • If a rule should fail, raise ValidationException with the failure message.

Example

from .base import (
    ActionValidationBase,
    ValidationBase,
    ValidationException,
)

class SuperAwesomeRepository(ActionValidationBase):
    category = "integration"

    async def async_validate(self):
        if self.repository != "super-awesome":
            raise ValidationException("The repository is not super-awesome")