codecov / basic-test-results

GitHub Actions to collect test results and emit a PR comment about the test status.
MIT License
2 stars 0 forks source link

Add an FAQ question on how to use this action. #3

Closed michelletran-codecov closed 1 month ago

michelletran-codecov commented 1 month ago

Add a bit of a note on how the comment should work, and talk about the potential race condition.

github-actions[bot] commented 1 month ago

:x: 2 Tests Failed:

Tests completed Failed Passed Skipped
2 2 0 0
View the top 2 failed tests by shortest run time > > ``` > subtracts 2 - 3 to equal -1 > ``` > >
Stack Traces | 0.000s run time > > > ``` > > Error: expect(received).toBe(expected) // Object.is equality > > > > Expected: 1 > > Received: -1 > > at Object.<anonymous> (/Users/josephsawaya/dev/test-result-action/demo/calculator/calculator.test.ts:10:31) > > at Promise.then.completed (/Users/josephsawaya/dev/test-result-action/node_modules/jest-circus/build/utils.js:298:28) > > at new Promise (<anonymous>) > > at callAsyncCircusFn (/Users/josephsawaya/dev/test-result-action/node_modules/jest-circus/build/utils.js:231:10) > > at _callCircusTest (/Users/josephsawaya/dev/test-result-action/node_modules/jest-circus/build/run.js:316:40) > > at processTicksAndRejections (node:internal/process/task_queues:95:5) > > at _runTest (/Users/josephsawaya/dev/test-result-action/node_modules/jest-circus/build/run.js:252:3) > > at _runTestsForDescribeBlock (/Users/josephsawaya/dev/test-result-action/node_modules/jest-circus/build/run.js:126:9) > > at run (/Users/josephsawaya/dev/test-result-action/node_modules/jest-circus/build/run.js:71:3) > > at runAndTransformResultsToJestFormat (/Users/josephsawaya/dev/test-result-action/node_modules/jest-circus/build/legacy-code-todo-rewrite/jestAdapterInit.js:122:21) > > at jestAdapter (/Users/josephsawaya/dev/test-result-action/node_modules/jest-circus/build/legacy-code-todo-rewrite/jestAdapter.js:79:19) > > at runTestInternal (/Users/josephsawaya/dev/test-result-action/node_modules/jest-runner/build/runTest.js:367:16) > > at runTest (/Users/josephsawaya/dev/test-result-action/node_modules/jest-runner/build/runTest.js:444:34) > > ``` > >
 adds 2 + 3 to equal 5
Stack Traces | 0.002s run time > ``` > Error: expect(received).toBe(expected) // Object.is equality > > Expected: 4 > Received: 5 > at Object.<anonymous> (/Users/josephsawaya/dev/test-result-action/demo/calculator/calculator.test.ts:5:26) > at Promise.then.completed (/Users/josephsawaya/dev/test-result-action/node_modules/jest-circus/build/utils.js:298:28) > at new Promise (<anonymous>) > at callAsyncCircusFn (/Users/josephsawaya/dev/test-result-action/node_modules/jest-circus/build/utils.js:231:10) > at _callCircusTest (/Users/josephsawaya/dev/test-result-action/node_modules/jest-circus/build/run.js:316:40) > at processTicksAndRejections (node:internal/process/task_queues:95:5) > at _runTest (/Users/josephsawaya/dev/test-result-action/node_modules/jest-circus/build/run.js:252:3) > at _runTestsForDescribeBlock (/Users/josephsawaya/dev/test-result-action/node_modules/jest-circus/build/run.js:126:9) > at run (/Users/josephsawaya/dev/test-result-action/node_modules/jest-circus/build/run.js:71:3) > at runAndTransformResultsToJestFormat (/Users/josephsawaya/dev/test-result-action/node_modules/jest-circus/build/legacy-code-todo-rewrite/jestAdapterInit.js:122:21) > at jestAdapter (/Users/josephsawaya/dev/test-result-action/node_modules/jest-circus/build/legacy-code-todo-rewrite/jestAdapter.js:79:19) > at runTestInternal (/Users/josephsawaya/dev/test-result-action/node_modules/jest-runner/build/runTest.js:367:16) > at runTest (/Users/josephsawaya/dev/test-result-action/node_modules/jest-runner/build/runTest.js:444:34) > ```

:mega: Thoughts on this report? Let Codecov know! | Powered by Codecov