Trivial changes to Codecov config file #6904
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added a comment at the top with general info about the purpose of this file. I had to track it down myself, so I figure it's worth adding here to make it easier to find in the future.
Most of the other config files for things like git, linters, and other things start with a leading `.`. In addition, the extension `.yaml` is the [officially-recommended one](https://en.wikipedia.org/wiki/YAML). Although this is a trivial issue, as part of general housekeeping, I propose we rename the file to `.codecov.yaml`. Codecov will look for the configuration file [whether it starts with a period or not](https://docs.codecov.com/docs/codecov-yaml#can-i-name-the-file-codecovyml), and it will also handle [both `.yml` and `.yaml` file extensions](https://github.com/codecov/codecov-cli/blob/b7033a99068447e5feefaddf2a36af0d45543f43/codecov_cli/helpers/config.py#L22).
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #6904 +/- ##
==========================================
- Coverage 97.86% 97.86% -0.01%
==========================================
Files 1084 1084
Lines 94225 94225
==========================================
- Hits 92215 92214 -1
- Misses 2010 2011 +1 ☔ View full report in Codecov by Sentry. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This does 2 things: add some orientation info at the top of the file, and rename the file to
.codecov.yaml.Most of the other config files for things like git, linters, and other things have names that start with a leading
.. In addition, the extension.yamlis the officially-recommended one. Although this is a trivial issue, as part of general housekeeping, I propose we rename the file to.codecov.yaml.Although I can't properly test it, inspecting the Codecov code shows that it will look for the configuration file whether it starts with a period or not, and it will also handle both
.ymland.yamlfile extensions.