From 13752510f5ceda4f01e2c43a626f7a829bd2758c Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Sat, 23 May 2026 13:54:15 +0000 Subject: [PATCH 1/2] Initial plan From bf73ba5f7ba6bb5229e93ce1f56e57e0759bd319 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Sat, 23 May 2026 14:04:39 +0000 Subject: [PATCH 2/2] Fix package README spec drift findings Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com> --- pkg/actionpins/README.md | 1 - pkg/console/README.md | 4 +++- pkg/jsonutil/README.md | 7 ++++++- pkg/parser/README.md | 4 +++- pkg/workflow/README.md | 4 +++- 5 files changed, 15 insertions(+), 5 deletions(-) diff --git a/pkg/actionpins/README.md b/pkg/actionpins/README.md index d8e07cb9354..b3f8f8972cc 100644 --- a/pkg/actionpins/README.md +++ b/pkg/actionpins/README.md @@ -27,7 +27,6 @@ Resolution supports two modes: | Function | Signature | Description | |----------|-----------|-------------| -| `GetActionPins` | `func() []ActionPin` | Returns all loaded pins | | `GetActionPinsByRepo` | `func(repo string) []ActionPin` | Returns all pins for a repository (version-descending) | | `GetLatestActionPinByRepo` | `func(repo string) (ActionPin, bool)` | Returns the latest pin for a repository | | `GetContainerPin` | `func(image string) (ContainerPin, bool)` | Returns a pinned container image by its original image reference | diff --git a/pkg/console/README.md b/pkg/console/README.md index aa262a2a5c4..9b1fbb80663 100644 --- a/pkg/console/README.md +++ b/pkg/console/README.md @@ -866,10 +866,12 @@ if err != nil || !confirmed { **Internal**: - `github.com/github/gh-aw/pkg/logger` — debug-level console logging -- `github.com/github/gh-aw/pkg/testutil` — shared test fixtures and assertion helpers used by console package tests - `github.com/github/gh-aw/pkg/styles` — adaptive color constants and pre-configured lipgloss styles - `github.com/github/gh-aw/pkg/tty` — terminal detection for spinner and progress bar +**Test-only**: +- `github.com/github/gh-aw/pkg/testutil` — shared test fixtures and assertion helpers used by console package tests + **External**: - `charm.land/lipgloss/v2` — terminal styling and layout - `charm.land/bubbles/v2/spinner` — spinner animation diff --git a/pkg/jsonutil/README.md b/pkg/jsonutil/README.md index a2b1998ab42..743a66c0079 100644 --- a/pkg/jsonutil/README.md +++ b/pkg/jsonutil/README.md @@ -31,11 +31,16 @@ if err != nil { // Note: '&&' and '||' are preserved — not escaped to \u0026\u0026 or \u007c\u007c ``` +## Dependencies + +**Internal**: +- `github.com/github/gh-aw/pkg/logger` — package-scoped logger used for marshal error diagnostics + ## Design Notes - Uses `json.Encoder` with `SetEscapeHTML(false)` rather than `json.Marshal` to suppress HTML escaping. - The trailing newline that `json.Encoder.Encode` appends is trimmed with `strings.TrimSuffix` so the result is consistent with `json.Marshal` output. -- This package has no internal or external dependencies beyond the Go standard library. +- The package has no external dependencies beyond the Go standard library. --- diff --git a/pkg/parser/README.md b/pkg/parser/README.md index b00b443de88..3bbe1002c23 100644 --- a/pkg/parser/README.md +++ b/pkg/parser/README.md @@ -267,13 +267,15 @@ Import caching is crucial for performance and cycle detection. The `ImportCache` - `github.com/github/gh-aw/pkg/fileutil` — file existence and path helper utilities - `github.com/github/gh-aw/pkg/gitutil` — Git remote and host detection helpers - `github.com/github/gh-aw/pkg/jsonutil` — compact JSON marshaling for frontmatter hash computation -- `github.com/github/gh-aw/pkg/testutil` — shared test fixtures and assertion helpers used by parser package tests - `github.com/github/gh-aw/pkg/types` — `BaseMCPServerConfig` - `github.com/github/gh-aw/pkg/typeutil` — safe type conversion helpers for dynamic frontmatter - `github.com/github/gh-aw/pkg/logger` — debug logging - `github.com/github/gh-aw/pkg/sliceutil` — slice helper utilities for validation and merging - `github.com/github/gh-aw/pkg/stringutil` — string normalization and ANSI/format helpers +**Test-only**: +- `github.com/github/gh-aw/pkg/testutil` — shared test fixtures and assertion helpers used by parser package tests + **External**: - `github.com/santhosh-tekuri/jsonschema/v6` — JSON schema validation - `github.com/goccy/go-yaml` — YAML 1.1/1.2 compatible parsing (for GitHub Actions compatibility) diff --git a/pkg/workflow/README.md b/pkg/workflow/README.md index 7ae9fcebbae..6c002008212 100644 --- a/pkg/workflow/README.md +++ b/pkg/workflow/README.md @@ -511,7 +511,6 @@ pkg/workflow ── FrontmatterConfig (typed structs) - `github.com/github/gh-aw/pkg/constants` — engine names, feature flags, job/step IDs - `github.com/github/gh-aw/pkg/console` — terminal formatting - `github.com/github/gh-aw/pkg/logger` — debug logging -- `github.com/github/gh-aw/pkg/testutil` — shared test fixtures and assertion helpers used by workflow package tests - `github.com/github/gh-aw/pkg/actionpins` — action pin data and pin lookup helpers - `github.com/github/gh-aw/pkg/jsonutil` — compact JSON marshaling for AWF configuration serialization - `github.com/github/gh-aw/pkg/semverutil` — semantic version helpers @@ -521,6 +520,9 @@ pkg/workflow ── FrontmatterConfig (typed structs) - `github.com/github/gh-aw/pkg/syncutil` — thread-safe one-shot caching (used for repository feature cache) - `github.com/github/gh-aw/pkg/types` — shared MCP types +**Test-only**: +- `github.com/github/gh-aw/pkg/testutil` — shared test fixtures and assertion helpers used by workflow package tests + **External**: - `github.com/goccy/go-yaml` — YAML 1.1/1.2 compatible marshaling - `go.yaml.in/yaml/v3` — standard YAML marshaling for non-Actions YAML