Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue with COVERALLS_FLAG_NAME statement in "Github Actions Gotcha" doc section #243

Closed
andy-maier opened this issue Nov 16, 2020 · 3 comments

Comments

@andy-maier
Copy link
Contributor

andy-maier commented Nov 16, 2020

The documentation states in section Github Actions Gotcha:

For parallel builds, you have to add a final step to let coveralls know the parallel build is finished. You also have
to set COVERALLS_FLAG_NAME to something unique to the specific step, so re-runs of the same job don’t keep
piling up builds:

I think that COVERALLS_FLAG_NAME is not required (maybe it was in the past?), and that if provided it does not need to be unique. I have successfully used version 2.1.2 of coveralls in parallel mode on GitHub Actions without specifying COVERALLS_FLAG_NAME. The resulting jobs combine successfully on coveralls.io. The identification string contains GITHUB_RUN_ID and a sequence number in any case, and COVERALLS_FLAG_NAME only adds to it:

I suggest to clarify that in the docs.

@andy-maier andy-maier changed the title Issue with GitHub Actions gotcha in documentation Issue with COVERALLS_FLAG_NAME statement in "Github Actions Gotcha" doc section Nov 16, 2020
@andy-maier
Copy link
Contributor Author

Addressed by PR #244.

@andy-maier
Copy link
Contributor Author

andy-maier commented Nov 16, 2020

Update: I played around with re-running jobs (via GitHub Actions re-run) and the effect is that coveralls.io still combines the jobs properly into a consolidated result for the same build, but in its list of it jobs within the build it shows e.g. 13 instead of the expected 10 jobs. I assume that is what the original text described in its statement about "piling up builds". However, it turns out that ths "piling up" happens in all of the three cases described above. You can see that in the linked examples, each of them should show 10 jobs in the build, but they show more. So while there is a "piling up bug" somewhere, it is not circumvented by specifying a unique value for COVERALLS_FLAG_NAME, as the original text had suggested. Also, very strange: The number of jobs shown for a build varies within certain limits when refreshing the browser window. That happens for all three cases.

Bottom line: When reviewing the PR, one consideration might be to describe the "piling up" effect, but at this point I'm not sure we have a way to avoid it, so the question is, is it worth while to say something about it. After all, the combined coverage result seems to be ok in all three cases, as far as I can tell.

@TheKevJames
Copy link
Owner

Thanks again for the PR!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants