dev: improve deprecation comments for GitHub Action format

alexandear · alexandear · commit bb53549bbf49 · 2024-11-18T14:09:12.000+02:00
diff --git a/pkg/config/output.go b/pkg/config/output.go
@@ -18,7 +18,7 @@ const (
 	OutFormatHTML              = "html"
 	OutFormatJunitXML          = "junit-xml"
 	OutFormatJunitXMLExtended  = "junit-xml-extended"
-	OutFormatGithubActions     = "github-actions" // Deprecated
+	OutFormatGithubActions     = "github-actions" // Deprecated: use OutFormatColoredLineNumber instead.
 	OutFormatTeamCity          = "teamcity"
 	OutFormatSarif             = "sarif"
 )
diff --git a/pkg/printers/githubaction.go b/pkg/printers/githubaction.go
@@ -15,7 +15,8 @@ type GitHubAction struct {
 }
 
 // NewGitHubAction output format outputs issues according to GitHub Action.
-// Deprecated
+//
+// Deprecated: use NewText instead.
 func NewGitHubAction(w io.Writer) *GitHubAction {
 	return &GitHubAction{w: w}
 }

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ const (`
`18`	`18`	`OutFormatHTML = "html"`
`19`	`19`	`OutFormatJunitXML = "junit-xml"`
`20`	`20`	`OutFormatJunitXMLExtended = "junit-xml-extended"`
`21`		`- OutFormatGithubActions = "github-actions" // Deprecated`
	`21`	`+ OutFormatGithubActions = "github-actions" // Deprecated: use OutFormatColoredLineNumber instead.`
`22`	`22`	`OutFormatTeamCity = "teamcity"`
`23`	`23`	`OutFormatSarif = "sarif"`
`24`	`24`	`)`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,8 @@ type GitHubAction struct {`
`15`	`15`	`}`
`16`	`16`
`17`	`17`	`// NewGitHubAction output format outputs issues according to GitHub Action.`
`18`		`-// Deprecated`
	`18`	`+//`
	`19`	`+// Deprecated: use NewText instead.`
`19`	`20`	`func NewGitHubAction(w io.Writer) *GitHubAction {`
`20`	`21`	`return &GitHubAction{w: w}`
`21`	`22`	`}`