codecov / feedback

A place to discuss feedback about the pull request and web product experience.
38 stars 10 forks source link

Unexplained IA environment variables #293

Closed michaelaubertcmc closed 9 months ago

michaelaubertcmc commented 9 months ago

Describe the bug The environment variables CODECOV_IA_HOST CODECOV_IA_PORT CODECOV_IA_SCHEME CODECOV_IA_HOST_HEADER mentioned in https://github.com/codecov/codecov-gateway/blob/main/README.md could, in theory, have something to do with the Impact Analysis feature.

There is, however, nothing on the internet (that I could find) about what they mean or how they are used by Codecov software. Github finds them nowhere in the open sourced code.

Environment (please complete the following information):

To Reproduce Steps to reproduce the behavior:

  1. read https://github.com/codecov/codecov-gateway/blob/main/README.md
  2. try to find information about any of the IA environment variables.

Expected behavior Either no mention of unsupported environment variables in the documentation (and example config files) or some information about what they mean.

drazisil-codecov commented 9 months ago

Hi @michaelaubertcmc ,

Is https://github.com/codecov/codecov-gateway/blob/0559332af7519cc4d1fd3b03399c54011fdceb90/config/1-backends.conf#L13 what you were looking for?

michaelaubertcmc commented 9 months ago

Hi @drazisil-codecov and thank you very much. So, I clearly I mis-used the Github search bar. I now see search results in a handful of files.

It's still not great to have to dig through the source code to look for what the IA acronym means. I was just guessing about "impact analysis" and I don't actually know whether I guessed correctly yet ;-)

I don't know what kind of service is supposed to be provided by that host at that port.

drazisil-codecov commented 9 months ago

Hi @michaelaubertcmc ,

No worries! GitHub's search is... something :D

I actually don't know what the IA part means either, though I think you have a good guess.

https://github.com/codecov/codecov-gateway/blob/0559332af7519cc4d1fd3b03399c54011fdceb90/config/codecov.map#L15

Yah, I would say that's correct :)

michaelaubertcmc commented 9 months ago

Hi @drazisil-codecov

So, with any luck, if the repositories I want to analyse don't use any of the languages supported by Impact Analysis (PHP, NodeJS, Python and Ruby) I should not need to set any of the IA variable in my self-hosted Codecov, right?

I'll give that a try and check that nothing breaks.

Should I maybe raise a PR to update the readme.md file with that information? Maybe a reviewer could confirm we understand the variables correctly?

Thank for your help.

drazisil-codecov commented 9 months ago

I think as long as you don't call /profilling (Which I think is an upload endpoint from the CLI)

PRs always wecome 🥳