Skip to content

livery.forge._schedules

livery.forge._schedules

The pipeline-schedule decline for a forge whose clock is in the workflow file.

GitHub and Gitea time a workflow through its own schedule trigger, so they have no schedule to create through the API; every method here raises livery.forge.Unsupported naming the capability, which is what lets a caller probe supports("pipeline_schedules") first and stay idempotent.

Classes:

Name Description
DeclinedSchedules

The livery.forge.Schedules of a forge that keeps its clock in the file.

DeclinedSchedules

DeclinedSchedules(forge_name: str)

The livery.forge.Schedules of a forge that keeps its clock in the file.

Methods:

Name Description
list

Decline by name.

ensure

Decline by name.

delete

Decline by name.

Source code in packages/forge/src/livery/forge/_schedules.py
def __init__(self, forge_name: str) -> None:
    self._forge_name = forge_name

list

list() -> tuple[Schedule, ...]

Decline by name.

Source code in packages/forge/src/livery/forge/_schedules.py
def list(self) -> tuple[Schedule, ...]:
    """Decline by name."""
    raise self._decline()

ensure

ensure(description: str, *, ref: str, cron: str, variables: Mapping[str, str] | None = None) -> Schedule

Decline by name.

Source code in packages/forge/src/livery/forge/_schedules.py
def ensure(
    self,
    description: str,
    *,
    ref: str,
    cron: str,
    variables: Mapping[str, str] | None = None,
) -> Schedule:
    """Decline by name."""
    raise self._decline()

delete

delete(description: str) -> bool

Decline by name.

Source code in packages/forge/src/livery/forge/_schedules.py
def delete(self, description: str) -> bool:
    """Decline by name."""
    raise self._decline()