Skip to content

Commit

Permalink
Update README.md to include force-exclude warning
Browse files Browse the repository at this point in the history
Updates README.md to include a warning about the default choice of `--force-exclude` being used by the github action. This warning includes links to the documentation for these settings. Addresses astral-sh#69
  • Loading branch information
schlerp committed Feb 23, 2024
1 parent cc575a3 commit 3eed698
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,13 @@ When running without `--fix`, Ruff's formatter hook can be placed before or afte
`ruff format` should never introduce new lint errors, so it's safe to run Ruff's format hook _after_
`ruff check --fix`.)

> [!IMPORTANT]
> By default this hook runs with the `--force-exclude` argument. This means that any excludes
> defined in `pyproject.toml` or `ruff.toml` will be excluded even when explicitly passed in via the
> CI runner, This can cause differences between how `ruff check` behaves locally and inside
> of CI. See the documentation for [exclude](https://docs.astral.sh/ruff/settings/#exclude) and
> [force-exclude](https://docs.astral.sh/ruff/settings/#force-exclude) for further details.
## License

MIT
Expand Down

0 comments on commit 3eed698

Please sign in to comment.