Merge pull request #1 from buildkite-plugins/bm/append_annotations

Fix annotation appending and env var issue

Author: mcncl

README.md

@@ -86,12 +86,39 @@ steps:
           bep_file: my-workspace/bazel-events.json
 ```
 
+### Multiple Bazel jobs in a pipeline with consolidated annotations
+
+```yaml
+steps:
+  - label: "🔨 Build with Bazel"
+    command: |
+      bazel build //... --build_event_json_file=bazel-build-events.json
+    plugins:
+      - bazel-annotate#v0.1.0:
+          bep_file: bazel-build-events.json
+          
+  - label: "🧪 Test with Bazel"
+    command: |
+      bazel test //... --build_event_json_file=bazel-test-events.json
+    plugins:
+      - bazel-annotate#v0.1.0:
+          bep_file: bazel-test-events.json
+          
+  - label: "📦 Package with Bazel"
+    command: |
+      bazel run //:package --build_event_json_file=bazel-package-events.json
+    plugins:
+      - bazel-annotate#v0.1.0:
+          bep_file: bazel-package-events.json
+```
+
 ## How It Works
 
 1. After your Bazel command runs, the plugin looks for the BEP file
 2. It parses the BEP data to extract build status, test results, and performance metrics
 3. It creates a detailed Buildkite annotation with this information
 4. The annotation shows success/failure status, test performance, and detailed error logs
+5. Multiple plugin usages in a pipeline will append to the same annotation, allowing for consolidated build information
 
 ## Troubleshooting
 

hooks/post-command

@@ -14,6 +14,18 @@ BEP_FILE=$(plugin_read_config BEP_FILE "")
 # Check if we should skip if no BEP file found
 SKIP_IF_NO_BEP=$(plugin_read_config SKIP_IF_NO_BEP "false")
 
+# Check if this is the first job to create the annotation
+# Only do this check if we're running in Buildkite
+if [ -n "${BUILDKITE:-}" ] && command -v buildkite-agent >/dev/null 2>&1; then
+  if buildkite-agent meta-data exists "bazel-annotate-header-created" 2>/dev/null; then
+    echo "Detected existing annotation header from metadata"
+    export BUILDKITE_PLUGIN_BAZEL_ANNOTATE_IS_FIRST_JOB="false"
+  else
+    echo "This appears to be the first job creating an annotation"
+    export BUILDKITE_PLUGIN_BAZEL_ANNOTATE_IS_FIRST_JOB="true"
+  fi
+fi
+
 # If we still don't have a BEP file, check if it exists at common locations
 if [[ -z "${BEP_FILE}" ]]; then
   # Try some common locations

lib/bazel-bep.bash

@@ -28,12 +28,35 @@ create_annotation() {
   local style="$1"
   local content="$2"
   local context_id="bazel-bep-results"
+  local job_name="${BUILDKITE_LABEL:-Unknown Job}"
+  local is_first_job="${BUILDKITE_PLUGIN_BAZEL_ANNOTATE_IS_FIRST_JOB:-true}"
 
   # Check if we're running in Buildkite
   if [ -n "${BUILDKITE:-}" ] && command -v buildkite-agent >/dev/null 2>&1; then
-    echo "Creating Buildkite annotation..."
+    # Modify content based on whether this is the first job
+    if [ "$is_first_job" != "true" ]; then
+      # If not the first job, add a job section instead of the main header
+      echo "Appending to existing Buildkite annotation..."
+      
+      # Replace the main header with a job-specific header or remove it
+      content=$(echo "$content" | sed '1,3d') # Remove the first 3 lines (header + blank line)
+      
+      # Add job-specific section header
+      content="### 🧩 ${job_name}\n\n${content}"
+    else
+      echo "Creating initial Buildkite annotation with header..."
+    fi
+    
     # Use printf to ensure newlines are properly interpreted
-    printf "%s" "$content" | buildkite-agent annotate --style "$style" --context "$context_id"
+    printf "%s" "$content" | buildkite-agent annotate --style "$style" --context "$context_id" --append
+    
+    # Signal to future jobs that they're not the first
+    if buildkite-agent meta-data exists "bazel-annotate-header-created" 2>/dev/null; then
+      echo "Header already marked as created in metadata"
+    else
+      echo "Setting metadata to indicate header has been created"
+      buildkite-agent meta-data set "bazel-annotate-header-created" "true" || true
+    fi
   else
     # We're not in Buildkite, just display the content on stdout
     echo "Not running in Buildkite. Would create annotation with style '$style':"
@@ -251,8 +274,10 @@ process_bep() {
     status_emoji="⏭️"
   fi
 
-  # Clean header for the output
-  local summary="## 🚀 Bazel Results
+  # Use job-specific header 
+  local job_label="${BUILDKITE_LABEL:-Bazel Results}"
+  # Simple, clean job header
+  local summary="### ${job_label}
 
 "
   # Add command used if running in Buildkite
@@ -362,13 +387,13 @@ $failure_details</details>
 "
   fi
 
-  # Add random inspirational quote
+  # Add extra spacing between appended annotations for better readability
   summary+="
+
+
 ---
 
-💡 **Random Dev Wisdom:**
 
-_$(get_random_quote)_
 "
 
   # Create the annotation

lib/plugin.bash

@@ -1,7 +1,8 @@
 #!/bin/bash
 set -euo pipefail
 
-PLUGIN_PREFIX="BAZEL_BEP_ANNOTATE"
+# The environment variables set by Buildkite don't include "BEP" in the prefix
+PLUGIN_PREFIX="BAZEL_ANNOTATE"
 
 # Reads either a value or a list from the given env prefix
 function prefix_read_list() {

tests/post-command.bats

@@ -8,7 +8,7 @@ setup() {
 
   # Setup environment
   export BUILDKITE=true
-  export BUILDKITE_PLUGIN_BAZEL_BEP_ANNOTATE_SKIP_IF_NO_BEP=false
+  export BUILDKITE_PLUGIN_BAZEL_ANNOTATE_SKIP_IF_NO_BEP=false
 
   # Mock the process_bep function to avoid relying on external tools
   cat > "$TEMP_DIR/mock-bazel-bep.bash" << 'EOF'
@@ -21,6 +21,8 @@ process_bep() {
   echo "Mock processing BEP file: $BEP_FILE"
   if [[ -f "$BEP_FILE" ]]; then
     echo "Mock BEP file exists, processing successful"
+    # Call create_annotation after successful processing
+    create_annotation "info" "This is a mock summary"
     return 0
   else
     echo "Mock BEP file does not exist"
@@ -31,7 +33,7 @@ process_bep() {
 create_annotation() {
   local style="$1"
   local content="$2"
-  echo "Mock annotation created with style: $style"
+  echo "Mock annotation created with style: $style and append flag enabled"
 }
 EOF
 
@@ -115,7 +117,7 @@ teardown() {
 
 @test "Skip when no BEP file and skip option is enabled" {
   # No BEP file, but we'll enable skip option
-  export BUILDKITE_PLUGIN_BAZEL_BEP_ANNOTATE_SKIP_IF_NO_BEP=true
+  export BUILDKITE_PLUGIN_BAZEL_ANNOTATE_SKIP_IF_NO_BEP=true
 
   # Ensure no common files exist
   rm -f "${BUILDKITE_BUILD_CHECKOUT_PATH:-$PWD}/bazel-events.json" || true
@@ -130,7 +132,7 @@ teardown() {
 
 @test "Fail when no BEP file and skip option is disabled" {
   # No BEP file, skip option disabled
-  export BUILDKITE_PLUGIN_BAZEL_BEP_ANNOTATE_SKIP_IF_NO_BEP=false
+  export BUILDKITE_PLUGIN_BAZEL_ANNOTATE_SKIP_IF_NO_BEP=false
 
   # Ensure no common files exist
   rm -f "${BUILDKITE_BUILD_CHECKOUT_PATH:-$PWD}/bazel-events.json" || true
@@ -146,7 +148,7 @@ teardown() {
 @test "Process BEP file when explicitly provided" {
   # Create a sample BEP file
   touch "$TEMP_DIR/sample.bep"
-  export BUILDKITE_PLUGIN_BAZEL_BEP_ANNOTATE_BEP_FILE="$TEMP_DIR/sample.bep"
+  export BUILDKITE_PLUGIN_BAZEL_ANNOTATE_BEP_FILE="$TEMP_DIR/sample.bep"
 
   run "$TEMP_DIR/hooks/post-command"
 
@@ -173,11 +175,22 @@ teardown() {
 
 @test "Skip when BEP file doesn't exist and skip is enabled" {
   # Reference a non-existent BEP file with skip enabled
-  export BUILDKITE_PLUGIN_BAZEL_BEP_ANNOTATE_BEP_FILE="$TEMP_DIR/nonexistent.bep"
-  export BUILDKITE_PLUGIN_BAZEL_BEP_ANNOTATE_SKIP_IF_NO_BEP=true
+  export BUILDKITE_PLUGIN_BAZEL_ANNOTATE_BEP_FILE="$TEMP_DIR/nonexistent.bep"
+  export BUILDKITE_PLUGIN_BAZEL_ANNOTATE_SKIP_IF_NO_BEP=true
 
   run "$TEMP_DIR/hooks/post-command"
 
   assert_success
   assert_output --partial "BEP file not found at '$TEMP_DIR/nonexistent.bep' and skip_if_no_bep is true"
 }
+
+@test "Verify annotations are created with append flag" {
+  # Create a sample BEP file
+  touch "$TEMP_DIR/sample.bep"
+  export BUILDKITE_PLUGIN_BAZEL_ANNOTATE_BEP_FILE="$TEMP_DIR/sample.bep"
+
+  run "$TEMP_DIR/hooks/post-command"
+
+  assert_success
+  assert_output --partial "Mock annotation created with style: info and append flag enabled"
+}