Skip to content

[spec-extractor] Update package specifications for tty, types, typeutil, workflow#38822

Merged
pelikhan merged 1 commit into
mainfrom
spec-extractor/2026-06-12-e5ac9146a43a9983
Jun 12, 2026
Merged

[spec-extractor] Update package specifications for tty, types, typeutil, workflow#38822
pelikhan merged 1 commit into
mainfrom
spec-extractor/2026-06-12-e5ac9146a43a9983

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Package Specification Updates

This PR updates README.md specifications for the following packages:

Package Status Exported Symbols
tty Up to date 2 functions
types Up to date 5 types, 1 method
typeutil Up to date 10 functions
workflow Updated 3 new symbols documented

What Changed

  • workflow: Added NewActionResolver constructor, ActionResolver.ResolveSHA method, and ResolveGhAwRef standalone function to the Action Pinning section. These were introduced in Resolve --gh-aw-ref branch/tag to commit SHA at compile time #38689 (Resolve --gh-aw-ref branch/tag to commit SHA at compile time) but were missing from the specification.
  • tty, types, typeutil: Verified up to date — no source changes since last extraction.

Extraction Method

  • Source code analysis of exported symbols, types, and constants
  • Package doc comment extraction
  • Dependency graph analysis
  • Usage pattern identification

Round-Robin State

  • Packages processed this run: tty, types, typeutil, workflow
  • Next packages in rotation: actionpins, agentdrain, cli, console (index 0)
  • Total packages: 20
  • Coverage: 20/20 packages have specifications

Auto-generated by Package Specification Extractor workflow — Run §27411055062

Generated by 📋 Package Specification Extractor · 954.3 AIC · ⌖ 16.1 AIC · ⊞ 22.1K ·

  • expires on Jun 15, 2026, 3:01 AM UTC-08:00

…AwRef

Add missing Action Pinning entries introduced by #38689:
- NewActionResolver constructor
- ActionResolver.ResolveSHA method
- ResolveGhAwRef standalone function

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation pkg-specifications labels Jun 12, 2026
@github-actions

Copy link
Copy Markdown
Contributor Author

Please post the remaining blocker summary or a quick ready-for-review confirmation.

Generated by 👨‍🍳 PR Sous Chef · 71.1 AIC · ⌖ 1.01 AIC · ⊞ 17.3K ·

@pelikhan pelikhan merged commit d0b7458 into main Jun 12, 2026
@pelikhan pelikhan deleted the spec-extractor/2026-06-12-e5ac9146a43a9983 branch June 12, 2026 13:53
@github-actions

Copy link
Copy Markdown
Contributor Author

Thanks for the automated spec update, @github-actions! 🤖 The change is tightly scoped — one file, 8 lines, well-described, and the new symbols (NewActionResolver, ActionResolver.ResolveSHA, ResolveGhAwRef) are correctly attributed to #38689.

One area that could strengthen the spec-extractor workflow over time:

  • No validation tests — the extracted spec content is not covered by any automated check (e.g., a test that asserts the README lists all exported symbols, or that the symbol count in the table matches go doc output). Without that, a future extraction error could go undetected until a human reviewer notices drift.

If you would like a coding agent to add that coverage:

Add a Go test (or shell-based CI check) that validates pkg/workflow/README.md stays in sync with the exported symbols of the workflow package.
The check should:
1. Run `go doc -all ./pkg/workflow/` and extract exported symbol names.
2. Assert that each exported symbol appears at least once in pkg/workflow/README.md.
3. Fail with a clear diff if any symbol is undocumented.
Place the test in pkg/workflow/ or scripts/ as appropriate for the project conventions.

Generated by ✅ Contribution Check · 412.2 AIC · ⌖ 13.3 AIC · ⊞ 24.7K ·

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