API¶

Pyrig plugin that schedules health checks weekly.

rig ¶

Pyrig integrations provided by this plugin.

configs ¶

Pyrig configuration overrides provided by this plugin.

version_control ¶

Version control configuration overrides.

remote ¶

Remote version control configuration overrides.

workflows ¶

GitHub Actions workflow overrides.

health_check ¶

GitHub Actions workflow generator for the health check CI stage.

HealthCheckWorkflowConfigFile ¶

Bases: HealthCheckWorkflowConfigFile

Health check workflow scheduled to run weekly.

cron_schedule ¶

cron_schedule() -> tuple[
    int, int, Literal["*"], Literal["*"], int
]

Return the weekly Monday schedule at 01:00 UTC.

Returns:

Type	Description
`tuple[int, int, Literal[''], Literal[''], int]`	Cron fields for minute, hour, day, month, and weekday.

Source code in src/pyrig_weekly_health_check/rig/configs/version_control/remote/workflows/health_check.py

def cron_schedule(self) -> tuple[int, int, Literal["*"], Literal["*"], int]:
    """Return the weekly Monday schedule at 01:00 UTC.

    Returns:
        Cron fields for minute, hour, day, month, and weekday.
    """
    return 0, 1, "*", "*", 1