ctrf-io / ctrf-io/github-test-reporter

Bug: status-check behavior

Open
#155 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
376
Forks
42
PR merge metrics
No merged PRs in 30d

Description

Hi, I'm facing an interesting behaviour using the status-check option. Maybe I didn't really understand its purpose, but afterwards is my configuration:

...
      - name: Publish test report
        uses: ctrf-io/github-test-reporter@v1
        if: always()
        with:
          report-path: "gen/tmp/unittests-*.xml"
          summary-report: true
          insights-report: true
          pull-request-report: true
          status-check: true
          status-check-name: 'Julians Check'
          comment-tag: '${{ github.workflow }}-${{ github.job }}'
          write-ctrf-to-file: ${{ env.CTRF_PROCESSED_REPORT }}
          title: 'Test Report'
          integrations-config: |
            {
              "junit-to-ctrf": {
                "enabled": true,
                "action": "convert",
                "options": {
                  "output": "${{ env.CTRF_REPORT_FILE }}",
                  "toolname": "junit-to-ctrf",
                  "useSuiteName": false,
                  "env": {
                    "appName": "..."
                  }
                }
              }
            }
        env:
            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Problem: Using this step configured as above, the following behaviour occurs during a test run with...

  • test errors: The status check appears as "failed" in my PR validation and the other two checks (which run before this one) I'm running reset from "Successful" to "Expected" state.
  • test success: The status check appears as "Expected" in the PR validation and does not update.

Is the described behaviour expected? Or did I misconfigured the step?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the GitHub Actions workflow step with status-check enabled and the shown configuration, then compare the status-check result for failing and successful tests. The issue is resolved when the behavior is explained and the status check and preceding checks reach the expected final states.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, typescript
Domain
ci-cd, testing
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.