Read a deploy's checks from Cloud Build or another runner

A Cloud Build pipeline, or any pipeline outside GitHub Actions, can wait for the checks of the deploy it made with proofline ci deploy. The step finds the deploy through the GitHub deployment the pipeline created, so it needs a stored token, the deployed commit, and the environment and task that deployment names. Its exit code reports what the checks recorded, and the pipeline decides what happens next.

Check which deploys the step can read#

The step reads the deploys Proofline recorded for the commit, the same deploys an environment's Deploys tab shows. A GitHub deployment that the pipeline created for the commit in the connected repository is listed, whether or not GitHub Actions created it. A deploy that Proofline observed only in AWS, with no GitHub deployment, is not listed. The step then finds no deploy to read, so it cannot establish a result for it, and ends with "No deploy of OWNER/NAME at COMMIT was recorded after MINUTES minutes. The result is not established."

Create a token for the step#

Organization tokens require an organization owner with operational access.

  1. Open Settings → API tokens → Tokens and select Create token.
  2. Enter a Name.
  3. Under Permissions, select Read reviews.
  4. Under Repositories, choose Selected repositories and select the deployed repository.
  5. Set Expires in to a lifetime that outlasts the waits the step will make.
  6. Select Create token, copy the token, then select I saved the token.

Store the token in the runner's secret manager and give it to the step as PROOFLINE_TOKEN. Set PROOFLINE_ORGANIZATION_ID to the organization that owns the repository.

Point the step at its deploy#

Give the step the full SHA of the commit the pipeline deployed. The command reads it from COMMIT_SHA, so on Cloud Build pass the build's $COMMIT_SHA substitution into the step's environment. On another runner, set COMMIT_SHA or pass --commit. A branch, tag or shortened SHA is refused. Pass the repository as --repo OWNER/NAME unless the step's checkout has the repository's GitHub remote.

Select the deploy with --environment and --task, set to the environment and task the pipeline gave its GitHub deployment, such as production and deploy. Leave out --run and --attempt. They name a GitHub Actions run, and a deployment created outside Actions names none, so either filter would match nothing. Choose the check to wait for with --until. The CI reference lists every option and exit code.

Keep the token valid through the wait#

The step uses a stored token as given and never renews it. A GitHub Actions job that exchanges its OIDC token is renewed during a long wait; a stored token is not. Each build therefore needs the token to stay valid until its wait ends, and --until 1d waits more than a day after the deploy lands. If the token expires during a wait, Proofline refuses the next read and the step ends with exit code 1, an authentication error, without a result about the deploy. Replace the token before it expires.

Search help

Tab to a result. Enter to open. Escape to close.