Skip to content

docs: document the config input parameter #97

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.

Sign up for GitHub

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

Merged
larsoner merged 2 commits into from
Jun 1, 2026
+12 −0
Merged

docs: document the config input parameter #97

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8e67535
docs: document the config input parameter
ehennestad Jun 1, 2026
7eae1d4
docs: clarify config input vs. auto-discovered config files
ehennestad Jun 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,18 @@ with:
exclude_file: src/foo
```

### Parameter: config

Path to a `codespell` config file. The file uses INI format with a `[codespell]` section.

This parameter is optional. By default `codespell` automatically reads configuration from `pyproject.toml`, `setup.cfg`, and `.codespellrc` in the working directory; use this parameter only to point at a config file in a non-standard location.

```yml
uses: codespell-project/actions-codespell@v2
with:
config: path/to/codespell.cfg
```

### Parameter: skip

Comma-separated list of files to skip (it accepts globs as well).
Expand Down
Loading