Adding support for custom titles.

README.md

@@ -31,7 +31,9 @@ steps:
       secret: ${{ github.TOKEN }}
       approvers: user1,user2
       minimum-approvals: 1
+      approval-issue-title: "title"
 ```
 
 - `approvers` is a comma-delimited list of all required approvers.
 - `minimum-approvals` is an integer that sets the minimum number of approvals required to progress the workflow. Defaults to ALL approvers.
+- `approval-issue-title` is a string that will be appened to the title of the issue.

action.yaml

@@ -10,6 +10,9 @@ inputs:
   minimum-approvals:
     description: Minimum number of approvals to progress workflow
     required: false
+  approval-issue-title:
+    description: The custom subtitle for the issue.
+    required: false
 runs:
   using: docker
   image: docker://ghcr.io/trstringer/manual-approval:1.4.0

approval.go

@@ -19,23 +19,25 @@ type approvalEnvironment struct {
 	minimumApprovals    int
 	approvalIssue       *github.Issue
 	approvalIssueNumber int
+	approvalIssueTitle  string
 }
 
-func newApprovalEnvironment(client *github.Client, repoFullName, repoOwner string, runID int, approvers []string, minimumApprovals int) (*approvalEnvironment, error) {
+func newApprovalEnvironment(client *github.Client, repoFullName, repoOwner string, runID int, approvers []string, minimumApprovals int, approvalIssueTitle string) (*approvalEnvironment, error) {
 	repoOwnerAndName := strings.Split(repoFullName, "/")
 	if len(repoOwnerAndName) != 2 {
 		return nil, fmt.Errorf("repo owner and name in unexpected format: %s", repoFullName)
 	}
 	repo := repoOwnerAndName[1]
 
 	return &approvalEnvironment{
-		client:           client,
-		repoFullName:     repoFullName,
-		repo:             repo,
-		repoOwner:        repoOwner,
-		runID:            runID,
-		approvers:        approvers,
-		minimumApprovals: minimumApprovals,
+		client:             client,
+		repoFullName:       repoFullName,
+		repo:               repo,
+		repoOwner:          repoOwner,
+		runID:              runID,
+		approvers:          approvers,
+		minimumApprovals:   minimumApprovals,
+		approvalIssueTitle: approvalIssueTitle,
 	}, nil
 }
 
@@ -45,6 +47,11 @@ func (a approvalEnvironment) runURL() string {
 
 func (a *approvalEnvironment) createApprovalIssue(ctx context.Context) error {
 	issueTitle := fmt.Sprintf("Manual approval required for workflow run %d", a.runID)
+
+	if a.approvalIssueTitle != "" {
+		issueTitle = fmt.Sprintf("%s: %s", issueTitle, a.approvalIssueTitle)
+	}
+
 	issueBody := fmt.Sprintf(`Workflow is pending manual review.
 URL: %s
 

constants.go

@@ -5,12 +5,13 @@ import "time"
 const (
 	pollingInterval time.Duration = 10 * time.Second
 
-	envVarRepoFullName     string = "GITHUB_REPOSITORY"
-	envVarRunID            string = "GITHUB_RUN_ID"
-	envVarRepoOwner        string = "GITHUB_REPOSITORY_OWNER"
-	envVarToken            string = "INPUT_SECRET"
-	envVarApprovers        string = "INPUT_APPROVERS"
-	envVarMinimumApprovals string = "INPUT_MINIMUM-APPROVALS"
+	envVarRepoFullName       string = "GITHUB_REPOSITORY"
+	envVarRunID              string = "GITHUB_RUN_ID"
+	envVarRepoOwner          string = "GITHUB_REPOSITORY_OWNER"
+	envVarToken              string = "INPUT_SECRET"
+	envVarApprovers          string = "INPUT_APPROVERS"
+	envVarMinimumApprovals   string = "INPUT_MINIMUM-APPROVALS"
+	envVarApprovalIssueTitle string = "INPUT_APPROVAL-ISSUE-TITLE"
 )
 
 var (

main.go

@@ -137,7 +137,10 @@ func main() {
 		os.Exit(1)
 	}
 
-	apprv, err := newApprovalEnvironment(client, repoFullName, repoOwner, runID, approvers, minimumApprovals)
+	approvalIssueTitle := os.Getenv(envVarApprovalIssueTitle)
+
+	apprv, err := newApprovalEnvironment(client, repoFullName, repoOwner, runID, approvers, minimumApprovals, approvalIssueTitle)
+
 	if err != nil {
 		fmt.Printf("error creating approval environment: %v\n", err)
 		os.Exit(1)