groundcover-github-action/action.yml at main · groundcover-com/groundcover-github-action · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
name: "groundcover OTEL CI/CD Export"
description: "Export GitHub Actions workflow runs as OpenTelemetry traces to groundcover"
author: "groundcover"

inputs:
  groundcoverEndpoint:
    description: >
      groundcover OTLP endpoint base URL. Supports https://, http://, and grpc:// schemes.
      Do not include /v1/traces — the exporter appends it automatically.
    required: true
  otlpHeaders:
    description: >
      Advanced. Comma-separated key=value pairs for OTLP exporter headers.
      Takes precedence over `apiKey` when both are set.
    required: false
  apiKey:
    description: >
      groundcover ingestion key.
    required: false
  githubToken:
    description: >
      GitHub token with actions:read permission. Required for private repos.
      Use secrets.GITHUB_TOKEN or a PAT.
    required: false
  runId:
    description: "Workflow Run ID to export. Defaults to the current workflow run."
    required: false
  otelServiceName:
    description: "Override the OTEL service.name resource attribute. Defaults to the workflow name."
    required: false
  traceparent:
    description: >
      W3C Trace Context traceparent header value (e.g., 00-<trace_id>-<span_id>-01).
      When provided, the workflow root span becomes a child of this trace context,
      enabling correlation between CI/CD traces and application traces.
      When omitted, a new root trace is created.
    required: false
  env:
    description: "Environment name (e.g., production, staging). Added as a resource attribute."
    required: false
  workload:
    description: "Workload name. Defaults to the workflow name."
    required: false
  extraAttributes:
    description: >
      Extra resource attributes as comma-separated key=value pairs.
      Example: "team=platform,region=us-east-1"
    required: false
  testResultsGlob:
    description: >
      Optional comma-separated glob patterns for JUnit XML test result files.
      Matching files are parsed and summarized onto the workflow root span.
    required: false
  testResultsArtifactPrefix:
    description: >
      Optional prefix of workflow-run artifacts holding JUnit XML test reports
      (e.g. "test-reports-"). Matching artifacts are downloaded and every test
      case becomes a span under its job span, so this works in workflow_run mode
      where testResultsGlob cannot see the test jobs' files. Each artifact must
      be named "<prefix><sanitized job name>", where the sanitized job name is
      the job's display name (its tail after " / " for reusable workflows) with
      every run of characters outside [A-Za-z0-9_.-] replaced by "-". Uploading
      jobs should use actions/upload-artifact with overwrite: true so reruns
      replace the previous attempt's reports.
    required: false
  maxFailureMessageLength:
    description: >
      Maximum length, in characters, of a failed test's message on its span and
      log record. Longer messages are cut at this length. Go test failures put the
      assertion after the test's own output, so a low cap can drop it.
    required: false
    default: "65536"
  exportLogs:
    description: >
      Download GitHub Actions job logs and export them as OpenTelemetry log records
      correlated with the matching job and step spans. Set to false to disable.
    required: false
    default: "true"
  groundcoverBaseUrl:
    description: >
      Base URL for your groundcover web app, used in PR comments that link to traces.
      Defaults to https://app.groundcover.com.
    required: false
    default: "https://app.groundcover.com"
  commentOnPr:
    description: >
      When true, upsert a single PR comment with the trace ID,
      a groundcover traces link pre-filtered by PR number, and the workflow run link.
      Requires issues: write permission.
    required: false
    default: "true"
  groundcoverDuration:
    description: >
      Duration window for the PR comment traces link. Defaults to "Last 6 hours".
    required: false
    default: "Last 6 hours"
  groundcoverBackendId:
    description: >
      Optional backendId query parameter for the PR comment traces link.
    required: false
  groundcoverTenantUUID:
    description: >
      Optional tenantUUID query parameter for the PR comment traces link.
    required: false

outputs:
  traceId:
    description: "The OpenTelemetry Trace ID of the exported trace"

branding:
  icon: "activity"
  color: "green"

runs:
  using: "node24"
  main: "dist/index.js"