Skip to content

Refactor shared value formatting and unify GitHub error/SHA classification paths #53018

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelikhan merged 8 commits into from
Aug 16, 2026
Merged

Refactor shared value formatting and unify GitHub error/SHA classification paths #53018

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
3bb758b
Initial plan
Copilot Aug 16, 2026
d07bf7c
Refactor shared formatters and error classifiers
Copilot Aug 16, 2026
3ef7e0d
Address review feedback on classifier and env formatting refactor
Copilot Aug 16, 2026
a0856f2
docs(adr): add draft ADR-53018 for error classifier centralization
github-actions[bot] Aug 16, 2026
49a8e93
Merge branch 'main' into copilot/refactor-duplicate-value-formatting-…
github-actions[bot] Aug 16, 2026
aaec1b1
Address SHA and auth classifier review feedback
Copilot Aug 16, 2026
7935c8f
Merge branch 'main' into copilot/refactor-duplicate-value-formatting-…
github-actions[bot] Aug 16, 2026
6f6c0ec
Clarify rate limit classifier documentation
Copilot Aug 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Address review feedback on classifier and env formatting refactor 
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
  • Loading branch information
@pelikhan
Copilot and pelikhan authored Aug 16, 2026
commit 3ef7e0d0137a0e07d9997e8a7ecd173595f80b48
1 change: 1 addition & 0 deletions pkg/cli/audit.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,6 +303,7 @@ func isPermissionErrorStr(s string) bool {
}
lower := strings.ToLower(s)
return strings.Contains(lower, "exit status 4") ||
strings.Contains(lower, "permission") ||
strings.Contains(lower, "gh auth login") ||
strings.Contains(lower, "to use github cli in a github actions workflow")
}
Expand Down
4 changes: 1 addition & 3 deletions pkg/cli/fetch.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ import (

"github.com/github/gh-aw/pkg/console"
"github.com/github/gh-aw/pkg/constants"
"github.com/github/gh-aw/pkg/errorutil"
"github.com/github/gh-aw/pkg/logger"
"github.com/github/gh-aw/pkg/parser"
"github.com/github/gh-aw/pkg/stringutil"
Expand Down Expand Up @@ -273,8 +272,7 @@ func isTransientSHAResolutionError(err error) bool {
}

errorText := strings.ToLower(err.Error())
if errorutil.IsRateLimitError(errorText) ||
strings.Contains(errorText, "http 429") ||
if strings.Contains(errorText, "http 429") ||
strings.Contains(errorText, "rate limit") ||
strings.Contains(errorText, "timeout") ||
strings.Contains(errorText, "timed out") ||
Expand Down
1 change: 0 additions & 1 deletion pkg/errorutil/errors.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,6 @@ func IsGoneError(err error) bool {
// The check is case-insensitive and matches known API phrases.
func IsRateLimitError(output string) bool {
matched := containsSubstring(output,
"api rate limit exceeded",
"rate limit exceeded",
"secondary rate limit",
)
Expand Down
14 changes: 8 additions & 6 deletions pkg/workflow/step_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,14 +236,16 @@ func StepsToSlice(steps []*WorkflowStep) []any {

// marshalEnvValue serializes a non-string env var value to a string suitable
// for use in a GitHub Actions step env block.
// Arrays and maps are serialized as JSON (e.g. ["a","b"]) so that shell
// consumers such as `jq --argjson` receive valid JSON.
// Typed slices produced by goccy/go-yaml (e.g. []string instead of []any)
// are normalized via reflection before marshaling.
// Scalar values (int, bool, float64, etc.) fall back to fmt.Sprint.
// Arrays and maps are serialized as JSON (e.g. ["a","b"]) via
// importinpututil.FormatResolvedValue so import substitutions and env
// serialization stay aligned. Scalar values (int, bool, float64, etc.)
// fall back to fmt.Sprint.
func marshalEnvValue(v any) string {

@github-actions github-actions Bot Aug 16, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[/codebase-design] marshalEnvValue now silently returns "" when FormatResolvedValue returns (_, false) and v == nil is false — i.e. it falls through to fmt.Sprint(v). But FormatResolvedValue returns false only for nil; all other types return true. The double-nil guard (if s, ok := ...; ok then if v == nil) therefore creates a dead-code branch: the second if v == nil is unreachable because FormatResolvedValue(nil) returns ("", false) so the first branch doesn't return, but then v == nil is true.

This means nil returns "" correctly, but the structure is confusing — a future FormatResolvedValue change that returns false for non-nil values (e.g. a marshalling error) would silently fall into fmt.Sprint.

💡 Suggested fix

Either log/surface the marshalling failure, or be explicit:

func marshalEnvValue(v any) string {
    if v == nil {
        return ""
    }
    if s, ok := importinpututil.FormatResolvedValue(v); ok {
        return s
    }
    return fmt.Sprint(v)
}

This makes the nil guard first-class and the fallback readable.

@copilot please address this.

Copilot AI Aug 16, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved the nil guard before FormatResolvedValue in aaec1b1.

if s, ok := importinpututil.FormatResolvedValue(v); ok {
return s
}
return ""
if v == nil {
return ""
}
return fmt.Sprint(v)
}
Loading