better error msg and support coverall.yml

JuliaCI / Coverage.jl

Take Julia code coverage and memory allocation results, do useful things with them

MIT License

174 stars 68 forks source link

better error msg and support coverall.yml #279

Closed Roger-luo closed 3 years ago

Roger-luo commented 4 years ago

currently on github actions, if the COVERALL_TOKEN is not set as env variable, the error msg will say ERROR: KeyError: key "service_name" not found instead of the error msg should be printed on a non-travis CI.

on the other hand, I guess using .coverall.yml is perferred by Coverall, given that they provide this instruction on their help page:

But currently Coverage.submit won't read this file, thus I added support for that.

vtjnash commented 3 years ago

Requests for corrections to the instructions should be posted to https://github.com/lemurheavy/coveralls-public/issues. But that's not the instructions I see for https://docs.coveralls.io/julia:

I've updated this code to include an explicit error if service_name is not detected (plus provided an extra environment variable to set it): https://github.com/JuliaCI/Coverage.jl/blob/5f75767166f2e7f51db02da8edc4b2fed7d999f6/src/coveralls.jl#L124-L126

The bolded text that shouts "do not make your repo token public" would often contradict the suggestion to use a .coverall.yml file, so I'm generally inclined not to support that.

Roger-luo commented 3 years ago

OK, I'll close this then.