Skip to content

Commit c1a83f6

Browse files
committed
style: fix trailing whitespace in validation workflow and expand OTEL docs
- Remove trailing whitespace from validate-action-output.yml workflow file - Add clarification to README about OpenTelemetry environment variable support - Document that OTEL_ variables are automatically read from job steps - Reference OpenTelemetry SDK environment variable specification for extended configuration options - Improve documentation clarity for users configuring the action
1 parent 9933aef commit c1a83f6

2 files changed

Lines changed: 10 additions & 4 deletions

File tree

.github/workflows/validate-action-output.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ jobs:
151151
- name: Generate normalized files
152152
run: |
153153
set -euo pipefail
154-
154+
155155
jq -f /tmp/normalize-traces.jq collector-logs/traces-exported-original.json > collector-logs/traces-actual.json
156156
jq -f /tmp/normalize-metrics.jq collector-logs/metrics-exported-original.json > collector-logs/metrics-actual.json
157157
@@ -193,15 +193,15 @@ jobs:
193193
194194
ACTUAL_JOB_COUNT=$(jq -r '[.resourceSpans[]?.scopeSpans[]?.spans[]? | select(.name | startswith("job:"))] | length' collector-logs/traces-actual.json)
195195
EXPECTED_JOB_COUNT=${{ inputs.expected-job-count }}
196-
196+
197197
echo "Expected job count: $EXPECTED_JOB_COUNT"
198198
echo "Actual job count: $ACTUAL_JOB_COUNT"
199-
199+
200200
if [ "$ACTUAL_JOB_COUNT" -ne "$EXPECTED_JOB_COUNT" ]; then
201201
echo "✗ Job count mismatch: expected $EXPECTED_JOB_COUNT, got $ACTUAL_JOB_COUNT"
202202
exit 1
203203
fi
204-
204+
205205
echo "✓ Job count validation passed"
206206
207207
# Show final collector status and logs for debugging

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -217,6 +217,12 @@ To configure the action, you need to set the following environment variables:
217217
| `FEATURE_METRICS` | No | `true` | Enable Metrics feature. |
218218
| `OTEL_LOG_LEVEL` | No | `info` | Log level. |
219219

220+
This action relies on the OpenTelemetry SDK, which automatically reads `OTEL_`
221+
environment variables from `jobs.<job_id>.steps[*].env`. The table above lists
222+
commonly used variables, but other variables defined in the
223+
[OpenTelemetry Environment Variable Specification](https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/)
224+
may also work depending on SDK support.
225+
220226
### Getting Started
221227

222228
We prepared a [Getting Started](./examples/google-cloud/README.md) to create

0 commit comments

Comments
 (0)