Skip to content

[spec-extractor] Update package specifications for agentdrain, cli, console, constants#40456

Merged
pelikhan merged 1 commit into
mainfrom
spec-extractor/2026-06-20-c70eb109b3ff9418
Jun 20, 2026
Merged

[spec-extractor] Update package specifications for agentdrain, cli, console, constants#40456
pelikhan merged 1 commit into
mainfrom
spec-extractor/2026-06-20-c70eb109b3ff9418

Conversation

@github-actions

@github-actions github-actions Bot commented Jun 20, 2026

Copy link
Copy Markdown
Contributor

Summary

Updates the pkg/constants package README with documentation for several constants that were missing from the reference. No code changes are included — this is a documentation-only commit.


What changed

pkg/constants/README.md — documentation update

Added reference entries for the following previously undocumented constants:

Constant Kind Notes
ExperimentArtifactName Artifact name A/B experiment state uploaded by the activation job
UsageArtifactName Artifact name Compact run metadata and token-usage files from the conclusion job
OtlpExportErrorsFilename Filename OTLP per-endpoint export failure log (otlp-export-errors.jsonl)
DetectAgentErrorsStepID Step ID Post-execution error detection step identifier
DefaultThreatDetectVersion Version Default version for the gh-aw-threat-detection binary

Added a new "Threat Detection Paths" section documenting three path constants:

Constant Value
ThreatDetectionLogPath /tmp/gh-aw/threat-detection/detection.log
ThreatDetectionDir /tmp/gh-aw/threat-detection
ThreatDetectionResultPath /tmp/gh-aw/threat-detection/detection_result.json

Why

These constants existed in code but were absent from the package-level reference documentation, making them harder to discover. This brings the README back in sync with the implementation.


Impact

Type Documentation only
Breaking change No
Tests required No
Affected packages pkg/constants (README only)

Generated by PR Description Updater for issue #40456 · 46.4 AIC · ⌖ 7.64 AIC · ⊞ 4.5K ·

Add missing constants to pkg/constants/README.md:
- ExperimentArtifactName and UsageArtifactName (artifact names)
- OtlpExportErrorsFilename (OTLP export failure log)
- DetectAgentErrorsStepID (agent job step ID)
- DefaultThreatDetectVersion (version constant)
- ThreatDetectionLogPath, ThreatDetectionDir, ThreatDetectionResultPath (new section)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions

Copy link
Copy Markdown
Contributor Author

This automated spec-extractor PR is a clean, focused documentation update 🟢 — adding 8 previously undocumented exported constants to pkg/constants/README.md, all source-verified against the Go package.

The only checklist flag is no test files, which is expected here since no Go source code was changed — this is a pure README update. There is nothing to unit-test.

If a follow-up pass is needed to verify that the added constant documentation is accurate against the actual source values:

Verify that the following constants added to pkg/constants/README.md are correctly documented against the Go source in pkg/constants/:
- ExperimentArtifactName and UsageArtifactName (artifact names)
- OtlpExportErrorsFilename (files-within-artifacts)
- DetectAgentErrorsStepID (agent job step IDs)
- DefaultThreatDetectVersion (version constants / infrastructure)
- ThreatDetectionLogPath, ThreatDetectionDir, ThreatDetectionResultPath (threat detection paths)
Report any mismatches between the README descriptions/values and the actual Go constant declarations.

Generated by ✅ Contribution Check · 131.8 AIC · ⌖ 7.82 AIC · ⊞ 5.9K ·

@pelikhan pelikhan merged commit feaec7b into main Jun 20, 2026
@pelikhan pelikhan deleted the spec-extractor/2026-06-20-c70eb109b3ff9418 branch June 20, 2026 14:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation pkg-specifications

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant