github-action attestor
Captures metadata about a GitHub Action execution — the action reference, type, inputs/outputs, exit code, and a small slice of GitHub Actions runtime context.
| Name | github-action |
|---|---|
| Predicate type | https://aflock.ai/attestations/github-action/v0.1 |
| Lifecycle | execute |
| Default binary? | No |
| Recommended trace | off — no syscall tracing needed |
| Auto-attaches when | Not auto-detected — attach explicitly with -a. |
The facts in this box are generated from the CI/lock binary's own catalog (cilock tools list). Do not hand-edit — run npm run gen:catalog.
What it captures
The attestor records pre-set action metadata supplied by the action runner, plus a few GITHUB_* env vars sampled at Attest() time. Unlike command-run, it does not itself shell out — execution happens via a runner-provided ExecuteFunc.
Top-level fields:
actionref— action reference such asactions/checkout@v4. Also emitted as a subject (actionref:<ref>).actiontype—javascript,docker, orcomposite.actionname—namefield from the action'saction.yml.actioninputs— the names of the user-provided inputs. Each non-empty value is recorded as******, never as the value: the attestor cannot tell which inputs carry${{ secrets.X }}. An empty value stays"".actionoutputs— the names of the captured outputs, values redacted the same way.exitcode— exit code returned by the execute function.actiondir— resolved local path of the action on disk.refpinned— true ifactionrefwas pinned to a commit SHA.docker— nestedDockerContainerConfig(populated only for docker actions):image,network,workspace,entrypoint,envcount,args.actionyamldigest— digest of the resolvedaction.yml, the file that decided what ran. (v0.2)steps— the compositerun:steps in execution order, each withindex,name,action,shell,workingDirectory,digest(of the exact bytes handed to the interpreter),script(only under content capture),exitCodeandskipped. (v0.2)childEnv— whether the action ran with the CI OIDC credentials withheld (ciOidcCredentials: "scrubbed", the default) or"inherited", plus thescrubbedvariable names (never values).runid— fromGITHUB_RUN_ID.workflowname— fromGITHUB_WORKFLOW.jobname— fromGITHUB_JOB.
The only GITHUB_* env vars consumed are GITHUB_RUN_ID, GITHUB_WORKFLOW, and GITHUB_JOB. Anything else about the workflow (event, actor, ref, sha, runner OS, repository) is not in this attestor — see github for OIDC-derived identity.
When to use
Inside GitHub Actions workflows when an action is being executed under cilock's action runner. cilock-action wires this attestor in by default; you generally don't add it manually.
Flags
None. The attestor is configured by the in-process action runner via functional options (WithActionRef, WithActionType, WithDockerConfig, WithExecuteFunc, etc.), not by CLI flags.
Output shape
{
"actionref": "actions/checkout@v4",
"actiontype": "javascript",
"actionname": "Checkout",
"actioninputs": { "ref": "******", "token": "******" },
"actionoutputs": { "ref": "******" },
"exitcode": 0,
"actiondir": "/runner/_actions/actions/checkout/v4",
"refpinned": false,
"docker": {
"image": "ghcr.io/example/action:1.2.3",
"network": "none",
"workspace": "/github/workspace",
"entrypoint": "/entrypoint.sh",
"envcount": 12,
"args": ["--flag"]
},
"runid": "1234567890",
"workflowname": "release",
"jobname": "build"
}Gotchas
- The predicate type is
https://aflock.ai/attestations/github-action/v0.2whenactionyamldigestorstepsis populated, andhttps://aflock.ai/attestations/github-action/v0.1otherwise, socilock run --attestations github-action(which records neither) still emits v0.1. Both are cilock-native types, not upstream in-toto or witness predicates. Attest()runs theExecuteFunc(if set) between material and product attestors, so file-system side effects of the action are visible toproduct. If execution fails,exitcodeis still recorded and the error is returned.- Only
actionrefbecomes a subject; if it's empty, the attestation has no subjects. - The three
GITHUB_*env vars are only read atAttest()time. Outside Actions they will simply be empty strings.
CLI example
Real GitHub Actions runtime context. Reads canonical GITHUB_* env vars exposed to every Actions job and records them in a predicate.
# Same workflow as the github attestor; both are run together:
cilock run --step github-validation \
--signer-file-key-path key.pem --outfile attestation.json --workingdir . \
--attestations environment,git,github,github-action \
-- echo "real GH Actions run" Validated alongside github in the same workflow run. This attestor records GITHUB_RUN_ID, GITHUB_WORKFLOW and GITHUB_JOB; repository, runner and OIDC context come from github. See the full real-data example at https://github.com/aflock-ai/attestor-compliance-examples/tree/main/20-github-action.
See also
- Catalog row
githubfor OIDC claims- GitHub Action reference
This page is generated from the CI/lock tool catalog. Don't edit it here — the source is attestation/detection/docs/github-action.doc.md in aflock-ai/rookery. The same catalog powers cilock tools show github-action in the CLI, so a single edit keeps the terminal and the website in sync.
Edit this page → · Add a new tool →
When you open the pull request: if you are an AI agent, add the ai-agent label. If you are a human, add the human label.
Reference generated from the product documentation. Match commands and support details to your installed release.