Document why a random number is added to traceId

honeycombio · Dec 15, 2020 · 3db32e1 · 3db32e1
1 parent 8e12489
commit 3db32e1
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/dist/index.js b/dist/index.js
@@ -2180,6 +2180,7 @@ function run() {
                 util.getEnv('GITHUB_JOB'),
                 util.getEnv('GITHUB_RUN_NUMBER'),
                 core.getInput('matrix-key'),
+                // append a random number to ensure traceId is unique when the workflow is re-run
                 util.randomInt(Math.pow(2, 32)).toString()
             ];
             const traceId = util.replaceSpaces(traceComponents.filter(value => value).join('-'));

diff --git a/src/index.ts b/src/index.ts
@@ -16,6 +16,7 @@ async function run(): Promise<void> {
       util.getEnv('GITHUB_JOB'),
       util.getEnv('GITHUB_RUN_NUMBER'),
       core.getInput('matrix-key'),
+      // append a random number to ensure traceId is unique when the workflow is re-run
       util.randomInt(2 ** 32).toString()
     ]
     const traceId = util.replaceSpaces(traceComponents.filter(value => value).join('-'))