Skip to content

Commit 0aadfa2

Browse files
committed
Update comments in integration tests workflow to clarify test data update process
1 parent ea12ef9 commit 0aadfa2

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

.github/workflows/integration-tests.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,14 @@ jobs:
4848
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
4949
run: npm run test
5050

51+
# This job tests the GitHub Action by running it against the collector and validating the output.
52+
# It compares the collected telemetry data with expected test data to ensure consistent structure.
53+
#
54+
# To update test data (.github/test-data/traces.json and metrics.json):
55+
# 1. Run this workflow by pushing changes or creating a PR
56+
# 2. After workflow completion, download the 'collector-logs' artifact from the GitHub Actions run page
57+
# 3. Extract the artifact and copy traces.json and metrics.json to .github/test-data/ directory
58+
# 4. Commit and push the updated test data files
5159
test-action:
5260
# This job should be last job in the workflow.
5361
needs: test-typescript

0 commit comments

Comments
 (0)