clean: Clarify the version of Codacy configuration file considered DOCS-677 #2102
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
|
Overall readability score: 53.83 (🔴 -0.01)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
Comment on lines
+21
to
+26
| - Codacy uses the version of the configuration file **in the branch being analyzed**. For example, if you open a pull request that includes changes to the Codacy configuration file, the analysis results take those changes into account. However, if the Codacy configuration file **in the default branch** includes settings to [ignore files](#syntax-for-ignoring-files): | ||
|
|
||
| - The analysis results of any branch always take the ignore settings defined **in the default branch** into account. | ||
| - The ignore settings of the Codacy configuration file **in the branch being analyzed** are cumulative and don't override the settings defined **in the default branch**. | ||
|
|
||
| For example, if the Codacy configuration file **in the default branch** excludes file A from analysis, that file will be excluded from analysis **in any branch being analyzed** even if you remove that rule from the Codacy configuration file in that branch. |
There was a problem hiding this comment.
@nicklem I could use your help here! 🙏
I believe the content is technically correct (see the thread), but it seems a bit verbose. Another pair of expert eyes can probably make it simpler. 😅 👀
There was a problem hiding this comment.
This is a tough one, definitely! Here are a couple of ideas. We can discuss these later (or even during the offiste!)
- If a pull request modifies the Codacy configuration file, Codacy uses the updated configuration file to analyze that pull request. However, this does not apply to ignored files (see next point).
- If a pull request removes an ignored path from the Codacy configuration file, any matching files will stay ignored until that pull request is merged into the default branch.
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.
Clarifies the version of the Codacy configuration file considered for analysis.
👀 Live preview
https://docs-677-configuration-file-version--docs-codacy.netlify.app/repositories-configure/codacy-configuration-file/#using-a-codacy-configuration-file