Skip to content

Include file and line in GitHub Actions warning text #289

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

Open
LarytheLord wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Include file and line in GitHub Actions warning text #289

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 6 additions & 1 deletion pkg/printer/githubactions.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,17 @@ func (p *GitHubActions) End() {
}

func formatResultForGitHubAction(r result.Result) string {
location := fmt.Sprintf("%s:%d:%d: ",
r.GetStartPosition().Filename,
r.GetStartPosition().Line,
r.GetStartPosition().Column)

return fmt.Sprintf("::%s file=%s,line=%d,col=%d::%s",
translateSeverityForAction(r.GetSeverity()),
r.GetStartPosition().Filename,
r.GetStartPosition().Line,
r.GetStartPosition().Column,
r.Reason())
location+r.Reason())
}

func translateSeverityForAction(s rule.Severity) string {
Expand Down
4 changes: 2 additions & 2 deletions pkg/printer/githubactions_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ func TestFormatResultForGitHubAction(t *testing.T) {
},
}
got := formatResultForGitHubAction(&testResult)
assert.Equal(t, "::warning file=my/file,line=5,col=3::"+testResult.Rule.Reason(testResult.Finding), got)
assert.Equal(t, "::warning file=my/file,line=5,col=3::my/file:5:3: "+testResult.Rule.Reason(testResult.Finding), got)
}

func TestTranslateSeverityForAction(t *testing.T) {
Expand All @@ -51,7 +51,7 @@ func TestGitHubActions_Print(t *testing.T) {
res := generateFileResult()
assert.NoError(t, p.Print(res))
got := buf.String()
expected := fmt.Sprintf("::warning file=foo.txt,line=1,col=6::%s\n", res.Results[0].Reason())
expected := fmt.Sprintf("::warning file=foo.txt,line=1,col=6::foo.txt:1:6: %s\n", res.Results[0].Reason())
assert.Equal(t, expected, got)
}

Expand Down