From 2eff89324a595d796a581851e57d99f011f18e77 Mon Sep 17 00:00:00 2001 From: Peter Newman Date: Fri, 5 Jun 2020 19:09:58 +0100 Subject: [PATCH 1/3] Update the docs with the correct repo --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f0de7e8..b3740aa 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Any warnings or errors will be annotated in the Pull Request. ## Usage ``` -uses: peternewman/actions-codespell@master +uses: codespell-project/actions-codespell@master ``` ### Parameter: path @@ -17,7 +17,7 @@ This can be useful if your project has code you don't want to spell check for so This parameter is optional; by default `codespell` will run on your whole repository. ``` -uses: peternewman/actions-codespell@master +uses: codespell-project/actions-codespell@master with: path: src ``` @@ -31,7 +31,7 @@ All errors and warnings are annotated in Pull Requests, but it will act like eve This parameter is optional; setting this to any value will enable it. ``` -uses: peternewman/actions-codespell@master +uses: codespell-project/actions-codespell@master with: only_warn: 1 ``` From 31e217abf1e2056f8ae24fd00ce979cc297b69d5 Mon Sep 17 00:00:00 2001 From: Peter Newman Date: Sat, 6 Jun 2020 02:04:09 +0100 Subject: [PATCH 2/3] Document some more parameters --- README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) diff --git a/README.md b/README.md index b3740aa..86ec47a 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,54 @@ Any warnings or errors will be annotated in the Pull Request. uses: codespell-project/actions-codespell@master ``` +### Parameter: check_filenames + +If set, check file names for spelling mistakes as well. + +This parameter is optional; by default `codespell` will only check the file contents. + +``` +uses: codespell-project/actions-codespell@master +with: + check_filenames: true +``` + +### Parameter: check_hidden + +If set, check hidden files (those starting with ".") for spelling mistakes as well. + +This parameter is optional; by default `codespell` will not check hidden files. + +``` +uses: codespell-project/actions-codespell@master +with: + check_hidden: true +``` + +### Parameter: exclude_file + +File with lines that should not be checked for spelling mistakes. + +This parameter is optional; by default `codespell` will check all lines. + +``` +uses: codespell-project/actions-codespell@master +with: + exclude_file: src/foo +``` + +### Parameter: skip + +Comma-separated list of files to skip (it accepts globs as well). + +This parameter is optional; by default `codespell` won't skip any files. + +``` +uses: codespell-project/actions-codespell@master +with: + skip: foo,bar +``` + ### Parameter: path Indicates the path to run `codespell` in. From ba475bf46ec001f5abb7fae873aa438548a23fae Mon Sep 17 00:00:00 2001 From: Peter Newman Date: Sat, 6 Jun 2020 02:05:34 +0100 Subject: [PATCH 3/3] Clarify the exclude_file input option behaviour --- action.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/action.yml b/action.yml index e65adf0..dad0d7c 100644 --- a/action.yml +++ b/action.yml @@ -11,7 +11,7 @@ inputs: requred: false default: '' exclude_file: - description: 'FILE with lines that should not be changed' + description: 'File with lines that should not be checked for spelling mistakes' requred: false default: '' skip: