add commit and pr in autogenerated issue body (#1226)

Co-authored-by: Pablo Baeyens <[email protected]>

Author: jelly-afk

.chloggen/include-pr-commit-autogenerated-issues.yaml

@@ -0,0 +1,16 @@
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: enhancement
+
+# The name of the component, or a single word describing the area of concern, (e.g. crosslink)
+component: issuegenerator
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Include commit and pr in issues generated by issuegenerator
+
+# One or more tracking issues related to the change
+issues: [1180]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext:

issuegenerator/main.go

@@ -36,6 +36,8 @@ const (
 	githubOwnerAndRepository = "GITHUB_REPOSITORY"
 	githubWorkflow           = "GITHUB_ACTION"
 	githubAPITokenKey        = "GITHUB_TOKEN" // #nosec G101
+	githubSHAKey             = "GITHUB_SHA"
+	githubRefKey             = "GITHUB_REF"
 
 	githubOwner      = "githubOwner"
 	githubRepository = "githubRepository"
@@ -51,6 +53,8 @@ const (
 Auto-generated report for ${jobName} job build.
 
 Link to failed build: ${linkToBuild}
+Commit: ${commit}
+PR: ${pr}
 
 ### Component(s)
 ${component}
@@ -62,6 +66,8 @@ this issue is open, will be added as comments with more information to this issu
 `
 	issueCommentTemplate = `
 Link to latest failed build: ${linkToBuild}
+Commit: ${commit}
+PR: ${pr}
 
 ${failedTests}
 `
@@ -239,6 +245,8 @@ func (rg *reportGenerator) getRequiredEnv() {
 	env[githubServerURL] = os.Getenv(githubServerURL)
 	env[githubRunID] = os.Getenv(githubRunID)
 	env[githubAPITokenKey] = os.Getenv(githubAPITokenKey)
+	env[githubSHAKey] = os.Getenv(githubSHAKey)
+	env[githubRefKey] = os.Getenv(githubRefKey)
 
 	for k, v := range env {
 		if v == "" {
@@ -264,6 +272,16 @@ func (rg *reportGenerator) templateHelper(param string) string {
 	case "component":
 		trimmedModule := trimModule(rg.envVariables[githubOwner], rg.envVariables[githubRepository], currentReport.module)
 		return getComponent(trimmedModule)
+	case "commit":
+		return rg.envVariables[githubSHAKey]
+	case "pr":
+		ref := rg.envVariables[githubRefKey]
+		parts := strings.Split(ref, "/")
+		if len(parts) == 4 && parts[1] == "pull" {
+			return "#" + parts[2]
+		}
+		rg.logger.Warn("Could not parse PR from GITHUB_REF", zap.String("GITHUB_REF", ref))
+		return "N/A"
 	default:
 		return ""
 	}

issuegenerator/main_test.go

@@ -224,6 +224,8 @@ func TestTemplateExpansion(t *testing.T) {
 		githubOwner:      "test-org",
 		githubRepository: "test-repo",
 		githubRunID:      "555555",
+		githubSHAKey:     "abcde12345",
+		githubRefKey:     "refs/pull/1234/merge",
 	}
 
 	// Sort the reports by module name to ensure deterministic order
@@ -245,6 +247,8 @@ func TestTemplateExpansion(t *testing.T) {
 Auto-generated report for ` + "`test-ci`" + ` job build.
 
 Link to failed build: https://github.com/test-org/test-repo/actions/runs/555555
+Commit: abcde12345
+PR: #1234
 
 ### Component(s)
 ` + "package1" + `
@@ -267,6 +271,8 @@ this issue is open, will be added as comments with more information to this issu
 			template: issueCommentTemplate,
 			expected: `
 Link to latest failed build: https://github.com/test-org/test-repo/actions/runs/555555
+Commit: abcde12345
+PR: #1234
 
 #### Test Failures
 -  ` + "`TestFailure`" + `