katia-sentry
commented
1 month ago Internal issue created https://github.com/codecov/engineering-team/issues/2081
Open SheffAtEnova opened 8 months ago
katia-sentry
commented
1 month ago Internal issue created https://github.com/codecov/engineering-team/issues/2081
What product do you want to improve? Codecov Cloud
Is your feature request related to a problem? Please describe. I'd like to provide explanatory comments in the Global YAML file for Codecov Cloud in the YAML itself, but the comments are deleted every time I save changes to the Global YAML file from the Codecov Cloud web UI.
Providing these comments allows other devs in the organization to understand the motivations behind the default configurations --directly within the configuration itself. We could provide context & motivations elsewhere, but that's one more hoop to jump through for devs trying to build an understanding of the tool and its configuration; having the info immediately available and adjacent to the configuration would be ideal.
Describe the solution you'd like I'd like for comments not to be cleared upon saving the Global YAML file in the Codecov Cloud web UI (or at least an understanding of why it would be problematic to support this).
Describe alternatives you've considered We can version our Codecov Cloud Global YAML in git and have the comments there, but then there's a synchronization headache between the file as we've defined it in version control and the file as it exists in Codecov Cloud. Any sort of trail pointing back to the commented version from the comment-less web UI version would also be lost as the comments would "fall off" of the web UI version when synced.
Additional context The docs appear to highlight this as a shortcoming, but I am curious as to why comments are not supported in the Global YAML and whether they could be with a simple low-impact change: https://docs.codecov.com/docs/codecov-yaml#global-yaml:~:text=cannot%20accept%20comments