Skip to content

Document checks list, lookups by commit, and rerun limits - #4273

Merged
tylerpaxton merged 5 commits into
mainfrom
tp.checks-list-rerun
Oct 21, 2026
Merged

tylerpaxton merged 5 commits into
mainfrom
tp.checks-list-rerun

Conversation

@tylerpaxton

Copy link
Copy Markdown
Contributor

What

This updates the Chainguard Checks pages for two changes to chainctl checks and the Checks platform, and for one limit that remains:

  • chainctl checks list lists your organization's pull request runs and runs after merging, not just the runs you started with chainctl checks run.
  • The commands that read runs find a run by a directory or a commit SHA.
  • During the beta, you still can't rerun checks after merging, either with Re-run on GitHub or with chainctl checks rerun. The pages now say what you see when you try.

Why

The pages still said "these never find your repositories' runs" and that chainctl checks list shows only your own runs. Readers who followed them would skip commands that work. The pages also didn't say that Re-run on a postsubmit check leaves it queued, so readers would wait for a run that never starts.

Stacked on #4271

This branch is stacked on #4271. Merge it after #4271 merges.

Changes by page

  • chainctl checks command reference
    • Name a run: adds the directory and commit SHA forms of REF, and explains run ID prefixes, including the post- prefix of runs after merging. Says that a pull request run or a run after merging from October 16, 2026, or earlier needs its whole ID, which only the commands that read runs accept. Explains which commit to pass to find a pull request's runs.
    • chainctl checks list: describes the runs it lists, the --ref and --trigger flags, the output columns, and the JSON fields. Notes that COMMIT is a short SHA, and that runs started with chainctl checks run have - under REF and PR.
    • chainctl checks rerun: REF can now be a directory, a commit SHA, or a run ID, as long as it names a pull request's run. Quotes the error the command prints for a run after merging, and documents --watch and the JSON output.
    • chainctl checks cancel: after you cancel a run, says how to run a pull request's checks again, and how to run checks after merging again.
  • Use Chainguard Checks on GitHub: says that Re-run on Chainguard Checks (postsubmit) shows the check as queued, but no run starts and the check stays queued. Also says that chainctl checks rerun fails for runs after merging.
  • Inspect and run checks with chainctl: adds the directory and commit SHA forms, and explains how to find the runs you started in chainctl checks list.
  • Workload identities and trust: reads the repository ID from a pull request or from a commit that ran checks after merging, because . returns no ID when the commit has no run. The example now passes --parent, so chainctl doesn't prompt for an organization in the middle of the pipe.
  • Troubleshoot Chainguard Checks: lists when a lookup by commit finds no run, including the earlier commits that a merge commit brings in. Links to the reference instead of repeating it.

How it was checked

  • Compared every claim with the chainctl 0.2.388 source, whose checks code matches 0.2.386, the documented minimum version. Also compared it with the Checks server code deployed today.
  • Live tests of reruns after merging:
    • chainctl checks rerun on a run after merging failed with cannot rerun: ... is neither a postsubmit Run nor a pull request's.
    • Re-run on Chainguard Checks (postsubmit) marked the check as queued on GitHub. Five minutes later, no run had started, and the check was still queued.
  • Ran read-only chainctl checks list and chainctl checks status commands against a test organization. They confirmed the documented columns and JSON fields, and that pull request runs from October 7 and 8 aren't listed. status found a run after merging by its full commit SHA and by a post- prefix of its ID, and printed the Repo ID: line.
  • Ran the repository's pre-commit hooks and markdownlint-cli2 0.23.3 on the changed files. Both pass.
  • Confirmed that all internal links and anchors on the changed pages resolve.

For reviewers

  • The pages don't say what TRIGGER shows for a run started with chainctl checks run, because it depends on when the run started. Runs from before a server change deployed on October 20, 2026, show -, which a read-only chainctl checks list confirmed for runs from October 14 and 15. In the chainctl 0.2.388 code, newer runs of this kind show presubmit, but --trigger presubmit doesn't list them. This wasn't tested live, because no newer run of this kind was available and starting one creates a run in production.
  • In chainctl 0.2.388, chainctl checks rerun --help says the command reruns a finished postsubmit run, but the server refuses these runs. The pages document what happens today. If reruns after merging start working, the rerun paragraphs on the reference and GitHub pages need an update.
  • Runs created before about 17:00 UTC on October 16, 2026, aren't in the newer format. The pages say "October 16, 2026, or earlier" to cover that whole day.

🤖 Generated with Claude Code

tylerpaxton and others added 3 commits October 20, 2026 13:56
Match chainctl 0.2.388. A session created with chainctl 0.2.383 or
later keeps running after you detach while it's busy, and parks after
it's been idle for 10 minutes, no later than 24 hours after you last
detach. Document what counts as busy, the busy command, --keep park,
the new default detach option, and how list shows busy and idle
sessions.

Document chainctl develop claude login, status, and logout, the owner
credential source, and how a session gets fresh Claude access tokens
whether or not you're attached. Update the Google Cloud refresh token
rules, add troubleshooting for parks and the held login, and raise the
minimum chainctl version to 0.2.386.

Name the timed detach options wherever a terminal keeps serving after
you detach, since "Detach — keep running while busy" doesn't, and
fix other accuracy and wording issues found in review.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Address the review comments on #4171 and #4172 that arrived after
they merged and that main doesn't already cover. Builds on #4269.

Checks: add reference sections for chainctl checks failures and
attempts, document cancel --force and that closing a pull request
doesn't cancel its run, and describe migrate without --dry. Add how
commands run, the variables Chainguard Checks sets, Git in a check's
VM, HTTPS interception, the trigger rule for needs and from, check
files beside ci.yaml, where packages come from, and a Run Docker
section. Fix the services input example, document that a check with
an identity keeps its base branch when.expr until the pull request
merges, and re-derive the revoke timings.

Workspaces: document clipboard copy, laptop sleep, what a park drops,
the 6-day renewal, session states, the session's guide for agents,
Share from laptop, what the .git sync sends, and gobuild caches in
develop.yaml. Say that an unattended agent can push to the checkout's
other remotes, and that a pushed workflow's GITHUB_TOKEN can act
before anyone reviews it.

Say that owner or limited_owner can accept terms and turn on both
products, and that init picks your only Starter or Team organization
whatever your role.

Update text that went stale in production: a run can take two hours,
a passing check with nothing to report gets no GitHub check of its
own, and a root check can use the Go build cache.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The Checks pages still said that chainctl checks list shows only the
runs you started, and that the commands can't find a run by its commit.
Both limits are gone. The pages also didn't say what happens when you
try to rerun checks after merging, which still doesn't work.

- chainctl checks reference: describe the directory and commit SHA
  forms of REF, run ID prefixes, and the whole IDs that runs from
  October 16, 2026, or earlier need. Document the --ref and --trigger
  flags, the columns and JSON fields of checks list, and rerun --watch.
  Quote the error that rerun prints for a run after merging, and say
  how to run checks after merging again once you cancel a run.
- Checks on GitHub: say that Re-run on a postsubmit check leaves it
  queued without starting a run, and that chainctl checks rerun fails.
- Inspect and run checks: pass a directory or commit SHA, and find the
  runs you started in checks list.
- Identities and trust: read the repository ID from a pull request or
  from a commit that ran checks after merging, and pass --parent.
- Troubleshooting: list when a lookup by commit finds no run, and link
  to the reference instead of repeating it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@vercel

vercel Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
chainguard-docs-preview Ready Ready Preview Oct 21, 2026 12:21am UTC
1 Skipped Deployment
Project Deployment Actions Updated
chainguard-docs Ignored Ignored Oct 21, 2026 12:21am UTC

Request Review

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Base automatically changed from tp.wc-docs-dan-fixes to main October 21, 2026 15:25
Resolve the conflict left by squash-merging #4271 to this branch's
side. Main's copy of that file matches #4271's original commit, so
the net change against main is unchanged.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@tylerpaxton
tylerpaxton marked this pull request as ready for review October 21, 2026 15:40
@tylerpaxton
tylerpaxton requested a review from a team as a code owner October 21, 2026 15:40
@tylerpaxton
tylerpaxton merged commit 5af2d25 into main Oct 21, 2026
7 checks passed
@tylerpaxton
tylerpaxton deleted the tp.checks-list-rerun branch October 21, 2026 15:40

This branch was successfully deployed

1 active deployment
Preview – chainguard-docs-preview — dafd8393 Deployed Oct 21, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants