Skip to content

Commit

Permalink
clean: Clarify the version of Codacy configuration file considered DO…
Browse files Browse the repository at this point in the history
…CS-677 (#2102)

* clean: Add clarification about the considered Codacy configuration file version

* clean: Move some admonition content to related section; Tweaks for clarity

* feat: Update general warning, and delete exception from ignored files section

* clean: Remove extra blank spaces
  • Loading branch information
claudiacarpinteiro authored Jun 24, 2024
1 parent 34407e9 commit af1af93
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/repositories-configure/codacy-configuration-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,10 @@ Codacy supports configuring certain advanced features through a configuration fi
## Using a Codacy configuration file

!!! important
If your repository has a Codacy configuration file, the [Ignored files settings](ignoring-files.md) defined on the Codacy UI don't apply and you must [ignore files using the configuration file](#syntax-for-ignoring-files) instead.
- If your repository has a Codacy configuration file, the [Ignored files settings](ignoring-files.md) defined on the Codacy UI don't apply and you must [ignore files using the configuration file](#syntax-for-ignoring-files) instead.
- Codacy always uses the configuration file **in the default branch**. New settings added to the Codacy configuration file by a pull request are also considered for the pull request analysis, but the existing configuration in the default branch takes precedence.

For example, 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.

To use a Codacy configuration file:

Expand Down

0 comments on commit af1af93

Please sign in to comment.