-
Notifications
You must be signed in to change notification settings - Fork 39
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
clean: Clarify the version of Codacy configuration file considered DOCS-677 #2102
base: master
Are you sure you want to change the base?
Conversation
Overall readability score: 53.83 (🔴 -0.01)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
- 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
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