require step_key or label for comment id

Author: Tyler Sullens

README.md

@@ -11,10 +11,13 @@ The use of this plugin requires that clusters are being used and that the secret
 
 ## 👩‍💻 Usage
 
+>The plugin expects at least one of `BUILDKITE_STEP_KEY` or `BUILDKITE_LABEL` to be set for proper usage.
+
 Add the following to your `pipeline.yml`:
 
 ```yaml
     steps:
+        key: approval-comment
         command: echo "~~~ :github: Add approval comment Pull Request"
         plugins:
             - pr-commenter#v0.3.0:
@@ -24,9 +27,11 @@ Add the following to your `pipeline.yml`:
 
 ### Enabling "Sticky" comments
 
-Set `allow-repeats: false` in order to post and update a single comment.
+Set `allow-repeats: false` in order to post and update a single comment. This configuration relies on `BUILDKITE_STEP_KEY` or `BUILDKITE_LABEL` being set _**and unique to the step**_.
+
 ```yaml
     steps:
+        key: approval-comment
         command: echo "~~~ :github: Add approval comment Pull Request"
         plugins:
             - pr-commenter#v0.3.0:

internal/issue/comment/comment.go

@@ -24,10 +24,18 @@ type GitHubClient interface {
 	EditComment(ctx context.Context, owner, repo string, commentID int64, comment *github.IssueComment) (*github.IssueComment, *github.Response, error)
 }
 
-func NewCommenter(client GitHubClient) *Commenter {
-	// Create a unique "id" embedded in the comment that identifies the comment generated by this pipeline+job
-	// The generated "id" is unique to the specific pipeline+job, with the plugin message-id param allowing further uniqueness
-	messageId := fmt.Sprintf("%s:%s:pr-commenter-buildkite-plugin", os.Getenv("BUILDKITE_PIPELINE_SLUG"), os.Getenv("BUILDKITE_LABEL"))
+func NewCommenter(client GitHubClient) (*Commenter, error) {
+	// Create a unique "id" embedded in the comment that identifies the comment generated by this pipeline+step
+	// The generated "id" is unique to the specific pipeline+step, with the plugin message-id param allowing further uniqueness
+	stepKey, found := os.LookupEnv("BUILDKITE_STEP_KEY")
+	if !found {
+		stepKey, found = os.LookupEnv("BUILDKITE_LABEL")
+		if !found {
+			return nil, errors.New("At least one of BUILDKITE_STEP_KEY or BUILDKITE_LABEL must be set.")
+		}
+	}
+
+	messageId := fmt.Sprintf("%s:%s:pr-commenter-buildkite-plugin", os.Getenv("BUILDKITE_PIPELINE_SLUG"), stepKey)
 	uniqueId, found := os.LookupEnv(common.PluginPrefix + "MESSAGE_ID")
 	if found {
 		messageId = fmt.Sprintf("%s:%s", messageId, uniqueId)
@@ -36,7 +44,7 @@ func NewCommenter(client GitHubClient) *Commenter {
 	return &Commenter{
 		client:    client,
 		messageId: messageId,
-	}
+	}, nil
 }
 
 func (c *Commenter) formatBody(message string) string {

internal/issue/comment/comment_test.go

@@ -30,19 +30,19 @@ func (m *mockGitHubClient) EditComment(ctx context.Context, owner, repo string,
 
 func TestPost(t *testing.T) {
 	t.Setenv("BUILDKITE_PIPELINE_SLUG", "test-pipeline")
-	t.Setenv("BUILDKITE_LABEL", "test-label")
+	t.Setenv("BUILDKITE_STEP_KEY", "test")
 	t.Setenv(common.PluginPrefix+"MESSAGE_ID", "1")
 
 	mockClient := &mockGitHubClient{
 		createComment: func(ctx context.Context, owner, repo string, number int, comment *github.IssueComment) (*github.IssueComment, *github.Response, error) {
-			if owner != "testdev" || repo != "hello" || number != 420 || *comment.Body != "Test comment\n\n<!-- test-pipeline:test-label:pr-commenter-buildkite-plugin:1 -->" {
+			if owner != "testdev" || repo != "hello" || number != 420 || *comment.Body != "Test comment\n\n<!-- test-pipeline:test:pr-commenter-buildkite-plugin:1 -->" {
 				t.Errorf("Unexpected arguments: owner=%s, repo=%s, number=%d, body=%s", owner, repo, number, *comment.Body)
 			}
 			return nil, nil, nil
 		},
 	}
 
-	commenter := comment.NewCommenter(mockClient)
+	commenter, _ := comment.NewCommenter(mockClient)
 
 	err := commenter.Post(context.Background(), "testdev", "hello", "420", "Test comment")
 	if err != nil {
@@ -52,7 +52,7 @@ func TestPost(t *testing.T) {
 
 func TestPostCommentEmptyBody(t *testing.T) {
 	mockClient := &mockGitHubClient{}
-	commenter := comment.NewCommenter(mockClient)
+	commenter, _ := comment.NewCommenter(mockClient)
 
 	err := commenter.Post(context.Background(), "testdev", "hello", "69", "")
 	if err == nil {
@@ -62,11 +62,11 @@ func TestPostCommentEmptyBody(t *testing.T) {
 
 func TestFindExistingComment_Found(t *testing.T) {
 	t.Setenv("BUILDKITE_PIPELINE_SLUG", "test-pipeline")
-	t.Setenv("BUILDKITE_LABEL", "test-label")
+	t.Setenv("BUILDKITE_STEP_KEY", "test")
 	t.Setenv(common.PluginPrefix+"MESSAGE_ID", "1")
 
 	expectedID := int64(123)
-	expectedBody := "Test comment\n\n<!-- test-pipeline:test-label:pr-commenter-buildkite-plugin:1 -->"
+	expectedBody := "Test comment\n\n<!-- test-pipeline:test:pr-commenter-buildkite-plugin:1 -->"
 	expectedURL := "https://github.com/test/repo/pull/1#issuecomment-123"
 
 	mockClient := &mockGitHubClient{
@@ -84,7 +84,7 @@ func TestFindExistingComment_Found(t *testing.T) {
 		},
 	}
 
-	commenter := comment.NewCommenter(mockClient)
+	commenter, _ := comment.NewCommenter(mockClient)
 	result, err := commenter.FindExistingComment(context.Background(), "testdev", "hello", "320")
 
 	if err != nil {
@@ -100,11 +100,11 @@ func TestFindExistingComment_Found(t *testing.T) {
 
 func TestUpdateComment_Success(t *testing.T) {
 	t.Setenv("BUILDKITE_PIPELINE_SLUG", "test-pipeline")
-	t.Setenv("BUILDKITE_LABEL", "test-label")
+	t.Setenv("BUILDKITE_STEP_KEY", "test")
 	t.Setenv(common.PluginPrefix+"MESSAGE_ID", "1")
 
 	commentID := int64(456)
-	expectedBody := "Updated comment\n\n<!-- test-pipeline:test-label:pr-commenter-buildkite-plugin:1 -->"
+	expectedBody := "Updated comment\n\n<!-- test-pipeline:test:pr-commenter-buildkite-plugin:1 -->"
 
 	mockClient := &mockGitHubClient{
 		editComment: func(ctx context.Context, owner, repo string, id int64, comment *github.IssueComment) (*github.IssueComment, *github.Response, error) {
@@ -118,7 +118,7 @@ func TestUpdateComment_Success(t *testing.T) {
 		},
 	}
 
-	commenter := comment.NewCommenter(mockClient)
+	commenter, _ := comment.NewCommenter(mockClient)
 	err := commenter.UpdateComment(context.Background(), "testdev", "hello", "Updated comment", commentID)
 
 	if err != nil {

main.go

@@ -60,7 +60,11 @@ func run() exitCode {
 		fmt.Fprintf(os.Stderr, "Error creating GitHub client: %s\n", err)
 		return exitError
 	}
-	commenter := comment.NewCommenter(client)
+	commenter, err := comment.NewCommenter(client)
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Error configuring commenter: %s\n", err)
+		return exitError
+	}
 
 	message, found := os.LookupEnv(common.PluginPrefix + "MESSAGE")
 	if !found {