codecov / codecov/codecov-action

[BUG] Validate flags argument

Open
#1,805 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

bug codecov/codecov-action
Dominant language
Python
Stars
1.7k
Forks
260
Avg merge
1d 7h
Merged PRs (30d)
1

Description

Describe the bug
We were dynamically generating the flags argument and passing it into flags: on the action using an environment variable. The report showed it was being uploaded. There were no upload processing errors. But codecov was not being triggered.

To Reproduce
Use:

   - name: Publish coverage report
      uses: codecov/codecov-action@v3
      with:
        token: ${{ secrets.CODECOV_TOKEN }}
        flags: $CODECOV
        name: ${{ matrix.name }}
        verbose: false
        fail_ci_if_error: true
      env:
        CODECOV_TOKEN: "${{ secrets.CODECOV_TOKEN }}"

Expected behavior
It should have some kind of warning if it does not support $ in the flags argument,. Instead it makes you think that the report was uploaded successfully and never shows in the UI.

We have since corrected our action to use ${{ env.CODECOV }} however it was not easy for us to track down.

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 examining how the action reads and validates the flags input, then reproduce the provided workflow using $CODECOV and ${{ env.CODECOV }}. Done means unsupported shell-style variable syntax produces a clear warning instead of appearing successful without triggering Codecov processing.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.