From 8e6753549dffd117bfaa4cd29784fe25d117ae76 Mon Sep 17 00:00:00 2001 From: ehennestad Date: Mon, 1 Jun 2026 14:47:06 +0200 Subject: [PATCH 1/2] docs: document the config input parameter The config input maps to codespell's --config flag in entrypoint.sh but was missing from the README. Add a parameter section for it, consistent with the other documented inputs. Co-Authored-By: Claude Opus 4.8 --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index b6f29d8..4716ae0 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,18 @@ with: exclude_file: src/foo ``` +### Parameter: config + +Path to a `codespell` config file (for example `setup.cfg` or `.codespellrc`). + +This parameter is optional; by default `codespell` will use its own configuration discovery. + +```yml +uses: codespell-project/actions-codespell@v2 +with: + config: .codespellrc +``` + ### Parameter: skip Comma-separated list of files to skip (it accepts globs as well). From 7eae1d4101a5c25eb06fed64f27f1ac8b1e5e76c Mon Sep 17 00:00:00 2001 From: ehennestad Date: Mon, 1 Jun 2026 14:51:01 +0200 Subject: [PATCH 2/2] docs: clarify config input vs. auto-discovered config files setup.cfg/.codespellrc/pyproject.toml are read automatically; the config input is for pointing at a config file in a non-standard location. Use a non-standard path in the example to reflect that. Co-Authored-By: Claude Opus 4.8 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4716ae0..43c74e0 100644 --- a/README.md +++ b/README.md @@ -48,14 +48,14 @@ with: ### Parameter: config -Path to a `codespell` config file (for example `setup.cfg` or `.codespellrc`). +Path to a `codespell` config file. The file uses INI format with a `[codespell]` section. -This parameter is optional; by default `codespell` will use its own configuration discovery. +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: .codespellrc + config: path/to/codespell.cfg ``` ### Parameter: skip