diff --git a/.github/workflows/testing.yml b/.github/workflows/testing.yml index 697e178..06d8410 100644 --- a/.github/workflows/testing.yml +++ b/.github/workflows/testing.yml @@ -59,20 +59,33 @@ jobs: check_filenames: true check_hidden: true # When using this Action in other repos, the --skip option below can be removed - skip: ./.git,./codespell-problem-matcher/test,./test + skip: ./.git,./codespell-problem-matcher/test,./test,./README.md,./.github/workflows/testing.yml + # Check our README (and this workflow) ignoring the two intentional typos + - uses: ./ + with: + check_filenames: true + check_hidden: true + path: ./README.md,./.github/workflows/testing.yml + ignore_words_list: abandonned,ackward diagnose_bats: name: Diagnose bats + needs: test + if: always() && needs.test.result == 'failure' runs-on: ubuntu-latest continue-on-error: true + strategy: + fail-fast: false + matrix: + codespell_pip_version: ['codespell'] + include: + - codespell_pip_version: 'git+https://github.com/codespell-project/codespell.git' steps: - uses: actions/checkout@v1 - name: Set up Python uses: actions/setup-python@v2 - - run: pip3 --quiet --quiet install git+https://github.com/codespell-project/codespell.git + - run: pip3 --quiet --quiet install ${{ matrix.codespell_pip_version }} - run: | - # Skip the bats diagnostics - exit 0 # Simulate the Dockerfile COPY command [ -d "${RUNNER_TEMP}/code/" ] || sudo mkdir -p ${RUNNER_TEMP}/code/ [ -f "${RUNNER_TEMP}/code/codespell-matcher.json" ] || sudo cp codespell-problem-matcher/codespell-matcher.json ${RUNNER_TEMP}/code/ diff --git a/README.md b/README.md index 86ec47a..898039b 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,44 @@ with: skip: foo,bar ``` +### Parameter: builtin + +Comma-separated list of builtin dictionaries to use. + +This parameter is optional; by default `codespell` will use it's default selection of built in dictionaries. + +``` +uses: codespell-project/actions-codespell@master +with: + builtin: clear,rare +``` + +### Parameter: ignore_words_file + +File that contains words which will be ignored by `codespell`. File must contain one word per line. +Words are case sensitive based on how they are written in the dictionary file. + +This parameter is optional; by default `codespell` will check all words for typos. + +``` +uses: codespell-project/actions-codespell@master +with: + ignore_words_file: .codespellignore +``` + +### Parameter: ignore_words_list + +Comma-separated list of words which will be ignored by `codespell`. +Words are case sensitive based on how they are written in the dictionary file. + +This parameter is optional; by default `codespell` will check all words for typos. + +``` +uses: codespell-project/actions-codespell@master +with: + ignore_words_list: abandonned,ackward +``` + ### Parameter: path Indicates the path to run `codespell` in. diff --git a/action.yml b/action.yml index 3e915f2..f8c31ed 100644 --- a/action.yml +++ b/action.yml @@ -23,11 +23,11 @@ inputs: required: false default: '' ignore_words_file: - description: 'File with a list of words to be ignored' + description: 'File with a list of words to be ignored. Words are case sensitive based on how they are written in the dictionary file' required: false default: '' ignore_words_list: - description: 'Comma-separated list of words to be ignored' + description: 'Comma-separated list of words to be ignored. Words are case sensitive based on how they are written in the dictionary file' required: false default: '' path: