You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(artifacts): document experiment artifact and set (#29649)
The `experiment` artifact (`constants.ExperimentArtifactName = "experiment"`)
was missing from the Artifacts reference page. Add it to:
- Quick Reference table (with constant, type, and description)
- Artifact Sets table (`--artifacts experiment`)
- New `## experiment` section with contents, CLI usage, and cross-reference
Also include `experiment` in the multi-file artifact list in the
Naming Compatibility prose.
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: docs/src/content/docs/reference/artifacts.md
+30-1Lines changed: 30 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,6 +19,7 @@ GitHub Agentic Workflows upload several artifacts during workflow execution. Thi
19
19
|`agent-output`|`constants.AgentOutputArtifactName`| Legacy/back-compat | Historical standalone agent output artifact (`agent_output.json`); in current compiled workflows this content is included in the unified `agent` artifact instead |
|`experiment`|`constants.ExperimentArtifactName`| Multi-file | A/B experiment state (`state.json`) uploaded by the activation job when experiments are declared in the frontmatter |
Legacy name: `threat-detection.log` (still supported for backward compatibility).
143
145
146
+
## `experiment`
147
+
148
+
The `experiment` artifact is uploaded by the **activation job** only when the workflow frontmatter declares one or more `experiments` entries. It is not present on runs without experiments.
149
+
150
+
### Contents
151
+
152
+
-`state.json` — Cumulative per-variant invocation counters used to balance A/B assignments across runs
153
+
154
+
### Accessing experiment data
155
+
156
+
```bash
157
+
# Download the experiment artifact for a specific run
158
+
gh aw audit <run-id> --artifacts experiment
159
+
160
+
# Display the A/B experiment section in the audit report
161
+
gh aw audit <run-id>
162
+
```
163
+
164
+
The `🧪 A/B Experiments` section of the audit report shows the variant chosen for the run and the cumulative counts:
Single-file artifacts are automatically flattened to root level regardless of their artifact directory name. Multi-file artifacts (`firewall-audit-logs`, `agent`, `activation`) retain their directory structure.
185
+
Single-file artifacts are automatically flattened to root level regardless of their artifact directory name. Multi-file artifacts (`firewall-audit-logs`, `agent`, `activation`, `experiment`) retain their directory structure.
0 commit comments