Treatment setServiceState

cicd/services::setServiceState

Parameters

↳ var description: string = ""
↳ var github: bool = false
↳ var github_project: string = ""
↳ var github_sha: string = ""
↳ var github_token: string = ""
↳ var gitlab: bool = false
↳ var gitlab_pipeline_id: string = ""
↳ var gitlab_project_id: string = ""
↳ var gitlab_ref: string = ""
↳ var gitlab_root_url: string = "https://gitlab.com/api/v4"
↳ var gitlab_sha: string = ""
↳ var gitlab_token: string = ""
↳ var log_response: bool = false
↳ var name: string
↳ var report: bool = true

Inputs

⇥ canceled: Block<void>
⇥ error: Block<void>
⇥ failed: Block<void>
⇥ pending: Block<void>
⇥ running: Block<void>
⇥ success: Block<void>

Report a CI/CD step state to one or more service integrations.

Accepts lifecycle signals (pending, running, success, error, failed, canceled) and forwards the corresponding state to GitHub and/or GitLab commit status APIs depending on the github and gitlab flags. Reporting is skipped entirely when report is false.

• name: the status context name shown in the CI/CD interface.
• description: optional human-readable description attached to the status.
• log_response: when true, logs the raw API response body at info level.
• github_token, github_project, github_sha: credentials and target for GitHub status API.
• gitlab_root_url, gitlab_token, gitlab_project_id, gitlab_sha, gitlab_ref, gitlab_pipeline_id: credentials and target for GitLab commit status API.

⚠️ GitHub and GitLab both reject (or silently drop) a state registration query received while a previous one for the same commit is still in flight, so each provider’s queries are sent strictly one after another: running is held back until the pending query has completed, and the terminal state (success, error, failed or canceled) is held back until the running query has completed. A query is considered “completed” whether it was actually sent or skipped (report/github/gitlab being false), so a disabled report never stalls the sequence.