Support **all** files instead of just **changed-files** in the report

[thiagocrepaldi]

It seems this action only renders the coverage for the files changed in the PR. However, I would like to use this action to show coverage for all the content of coverage.xml, even if they refer to files not changed in the PR.

[ewjoachim]

what kind of report are you looking for ? In your usecase, if I understand correctly, there's no PR, so there's no report comment ?

[thiagocrepaldi]

No, it seems that although coverage.xml has coverage info for hundreds of files that were traced during unit tests, only the files modified in the PR are being listed in the PR comment.

On my scenario, I would like that all coverage information present in coverage.xml would be present in the PR comment.

For instance, my project has dozens of unit tests that covers hundreds of python files, but the PR comment only shows coverage info for the files being modified/added by that PR in specific. It seems the other files that are not modified by PR, although are present and covered by coverage.xml, are ignored during the PR comment processing

makes sense?

[thiagocrepaldi]

For reference, I have the impression that python-coverage-comment behaves similar to https://github.com/MishaKav/pytest-coverage-comment?tab=readme-ov-file#-advanced-features when report-only-changed-files: true is passed in to it

[ewjoachim]

I'm not sure I understand what PR you're talking about, given you mentioned a nightly build (so no code change ?)

As far as I can tell, the relevant code that decides what files to show on the PR is here. A file might be selected if it has diff (which it won't in your case if I understand correctly), OR if it has different coverage info compared to the last run (which is what you're after, if I understand correctly), so I'm not sure I understand what you're interested in.

On the coverage branch (the link is for this repo, but you'd look for the similarily named branch on YOUR repo), you have a full report of all the files (it might be a bit long) and links to HTML coverage (though no evolution)

[thiagocrepaldi]

Thanks @ewjoachim. Forget about the nightly build. I was researching this topic when report this issue. My bad.

My request is probably a special case for the per PR scenario, in which coverage is shown regardless of having a diff. If the file is present at coverage.xml, it should be listed by the action.

My PR produces a coverage.xml which is a subset of the branch, but contains files without changes on that PR. Makes sense now? sorry for the confusing report

[ewjoachim]

So you'd need to show files:

• Without a file number limit (you can already set MAX_FILES_IN_COMMENT for that)
• Even if they were not modified AND their coverage didn't change

I think the main issue you'll find is the GitHub comment character limit. The current max number of file shown is computed so as to avoid getting over the limit. If we wanted to show every file, we'd likely need a much more lightweight template, in particular: remove the alt-texts on the badges, possibly remove some columns. You can already set COMMENT_TEMPLATE for that.

I'm not sure I see a usecase other users may have for this, but I could accept a setting that includes files in the comment even if they don't have anything relevant.

You would just need the following:

python-coverage-comment-action/coverage_comment/template.py

Line 223 in f42698b

if has_diff or has_evolution_from_previous:

- if has_diff or has_evolution_from_previous:
+ if include_all_files_in_comment or has_diff or has_evolution_from_previous:

Want to contribute the PR ?

[thiagocrepaldi]

So you'd need to show files:

• Without a file number limit (you can already set MAX_FILES_IN_COMMENT for that)
• Even if they were not modified AND their coverage didn't change

I think the main issue you'll find is the GitHub comment character limit. The current max number of file shown is computed so as to avoid getting over the limit. If we wanted to show every file, we'd likely need a much more lightweight template, in particular: remove the alt-texts on the badges, possibly remove some columns. You can already set COMMENT_TEMPLATE for that.

I'm not sure I see a usecase other users may have for this, but I could accept a setting that includes files in the comment even if they don't have anything relevant.

You would just need the following:

python-coverage-comment-action/coverage_comment/template.py

Line 223 in f42698b

if has_diff or has_evolution_from_previous:

• if has_diff or has_evolution_from_previous:

• if include_all_files_in_comment or has_diff or has_evolution_from_previous:
  Want to contribute the PR ?

you are right, the comment character limit is an issue for such a rich template like this one. I will try doing some experiments and see how it goes