Generated reference for the harmont Triggers API.
pr
Trigger on a GitHub pull_request event.
branches filters by the PR's target branch. types selects
PR-action keywords; defaults to opened/synchronize/reopened (mirrors
GHA).
pr(branches=None, types=None) -> PullRequestTrigger| Parameter | Type | Default | Description |
|---|---|---|---|
branches | str | list[str] | tuple[str, ...] | None | None | — |
types | list[str] | tuple[str, ...] | None | None | — |
Returns PullRequestTrigger
pull_request
Trigger on a GitHub pull_request event.
branches filters by the PR's target branch. types selects
PR-action keywords; defaults to opened/synchronize/reopened (mirrors
GHA).
pull_request(branches=None, types=None) -> PullRequestTrigger| Parameter | Type | Default | Description |
|---|---|---|---|
branches | str | list[str] | tuple[str, ...] | None | None | — |
types | list[str] | tuple[str, ...] | None | None | — |
Returns PullRequestTrigger
push
Trigger on a git push.
Pass exactly one of branch or tag. Each is a glob or list
of globs (* matches any chars including /; ? matches one
char).
push(branch=None, tag=None) -> PushTrigger| Parameter | Type | Default | Description |
|---|---|---|---|
branch | str | list[str] | tuple[str, ...] | None | None | — |
tag | str | list[str] | tuple[str, ...] | None | None | — |
Returns PushTrigger
schedule
Trigger on a UTC cron schedule.
cron is a five-field crontab expression (minute hour day month
dow). Always interpreted as UTC.
schedule(cron) -> ScheduleTrigger| Parameter | Type | Default | Description |
|---|---|---|---|
cron | str | required | — |
Returns ScheduleTrigger