Skip to content

Commit 68f9d6e

Browse files
committed
Update script comments
1 parent 86f23b0 commit 68f9d6e

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

.github/scripts/test-results.sh

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,17 @@ set -eo pipefail # For jq to propagate yq failures.
55
# This script processes the XML tests results and outputs a NDJSON stream with one document per test execution.
66
# Hence, each document corresponds to a testcase entry in the XML. It contains the following fields:
77
#
8+
# - 'timestamp': As the testsuite (parent of the entry) timestamp field.
89
# - 'suite_name': As the entry class name.
910
# - 'test': As the entry name.
10-
# - 'result': success/failure/pass from the optional child node of the entry. No child node means success.
11-
# - 'timestamp': As the testsuite (parent of the entry) timestamp field.
11+
# - 'result': success/failure/skipped from the optional child node of the entry. No child node means success.
12+
# - 'reason': As the entry child (skipped or failure) contents. For example, in the source, <failure>SOURCE FOR REASON</failure>.
1213
# - 'duration_seconds': As the time field of the entry.
13-
# - 'reason': As the entry child (pass or failure) contents. For example, in the source, <failure>SOURCE FOR REASON</failure>.
1414
# - 'workflow_run_id': As the content of the environment variable 'WORKFLOW_RUN_ID'
1515
# - 'workflow_run_link': As the content of the environment variable 'WORKFLOW_RUN_LINK'
16-
# - 'workflow_retry_number': As the content of the environment variable 'WORKFLOW_RUN_NUMBER'
1716
# - 'workflow_head_branch': As the content of the environment variable 'WORKFLOW_HEAD_BRANCH'
17+
# - 'workflow_retry_number': As the content of the environment variable 'WORKFLOW_RUN_NUMBER'
18+
# - 'commit_sha': As the content of the environment variable 'COMMIT_SHA'
1819
#
1920
# INPUT:
2021
# - The XML file(s) to process. For example, the test results generated by JUnit in the 'target/surefire-reports' directory.
@@ -23,6 +24,7 @@ set -eo pipefail # For jq to propagate yq failures.
2324
# - WORKFLOW_RUN_LINK
2425
# - WORKFLOW_HEAD_BRANCH
2526
# - WORKFLOW_RUN_NUMBER
27+
# - COMMIT_SHA
2628
#
2729
# OUTPUT: NDJSON stream through stdout.
2830
#

0 commit comments

Comments
 (0)