diff --git a/.github/workflows/publish_master.yml b/.github/workflows/publish_master.yml index 7e2ebd8..f38f0de 100644 --- a/.github/workflows/publish_master.yml +++ b/.github/workflows/publish_master.yml @@ -13,7 +13,7 @@ jobs: name: Publish master image runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Build run: | GITHUB_REPOSITORY_LC=$(echo "${GITHUB_REPOSITORY}" | tr [A-Z] [a-z]) diff --git a/.github/workflows/publish_stable.yml b/.github/workflows/publish_stable.yml index 18283fc..4aabefa 100644 --- a/.github/workflows/publish_stable.yml +++ b/.github/workflows/publish_stable.yml @@ -10,7 +10,7 @@ jobs: name: Publish stable image runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Build run: | GITHUB_REPOSITORY_LC=$(echo "${GITHUB_REPOSITORY}" | tr [A-Z] [a-z]) diff --git a/.github/workflows/testing.yml b/.github/workflows/testing.yml index 554eafe..62ca0bf 100644 --- a/.github/workflows/testing.yml +++ b/.github/workflows/testing.yml @@ -19,10 +19,10 @@ jobs: steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Set up Python - uses: actions/setup-python@v4 + uses: actions/setup-python@v5 with: python-version: '3.10' @@ -48,7 +48,7 @@ jobs: name: Test run action runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - uses: ./ with: path: test/testdata @@ -58,13 +58,13 @@ jobs: name: Check for spelling errors runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - uses: ./ with: 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,./README.md,./.github/workflows/testing.yml + skip: ./.git,./codespell-problem-matcher/test,./test,./README.md,./.github/workflows/testing.yml,./.pre-commit-config.yaml # Check our README (and this workflow) ignoring the two intentional typos - uses: ./ with: @@ -86,9 +86,9 @@ jobs: include: - codespell_pip_version: 'git+https://github.com/codespell-project/codespell.git' steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Set up Python - uses: actions/setup-python@v4 + uses: actions/setup-python@v5 - run: pip3 --quiet --quiet install ${{ matrix.codespell_pip_version }} - run: | # Simulate the Dockerfile COPY command diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..4c71139 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,8 @@ +repos: + - repo: https://github.com/codespell-project/codespell + rev: v2.3.0 + hooks: + - id: codespell + args: [--ignore-words-list, "abandonned,ackward,bu"] + additional_dependencies: + - tomli diff --git a/README.md b/README.md index 2c845ce..84597fc 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Any warnings or errors will be annotated in the Pull Request. ## Usage ```yml -uses: codespell-project/actions-codespell@v1 +uses: codespell-project/actions-codespell@v2 ``` ### Parameter: check_filenames @@ -16,7 +16,7 @@ If set, check file names for spelling mistakes as well. This parameter is optional; by default `codespell` will only check the file contents. ```yml -uses: codespell-project/actions-codespell@v1 +uses: codespell-project/actions-codespell@v2 with: check_filenames: true ``` @@ -28,7 +28,7 @@ If set, check hidden files (those starting with ".") for spelling mistakes as we This parameter is optional; by default `codespell` will not check hidden files. ```yml -uses: codespell-project/actions-codespell@v1 +uses: codespell-project/actions-codespell@v2 with: check_hidden: true ``` @@ -40,7 +40,7 @@ File with lines that should not be checked for spelling mistakes. This parameter is optional; by default `codespell` will check all lines. ```yml -uses: codespell-project/actions-codespell@v1 +uses: codespell-project/actions-codespell@v2 with: exclude_file: src/foo ``` @@ -52,7 +52,7 @@ Comma-separated list of files to skip (it accepts globs as well). This parameter is optional; by default `codespell` won't skip any files. ```yml -uses: codespell-project/actions-codespell@v1 +uses: codespell-project/actions-codespell@v2 with: skip: foo,bar ``` @@ -64,7 +64,7 @@ Comma-separated list of builtin dictionaries to use. This parameter is optional; by default `codespell` will use its default selection of built in dictionaries. ```yml -uses: codespell-project/actions-codespell@v1 +uses: codespell-project/actions-codespell@v2 with: builtin: clear,rare ``` @@ -77,7 +77,7 @@ 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. ```yml -uses: codespell-project/actions-codespell@v1 +uses: codespell-project/actions-codespell@v2 with: ignore_words_file: .codespellignore ``` @@ -90,7 +90,7 @@ 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. ```yml -uses: codespell-project/actions-codespell@v1 +uses: codespell-project/actions-codespell@v2 with: ignore_words_list: abandonned,ackward ``` @@ -104,7 +104,7 @@ If set to "*", all misspelling in URIs and emails will be ignored. This parameter is optional; by default `codespell` will check all URIs and emails for typos. ```yml -uses: codespell-project/actions-codespell@v1 +uses: codespell-project/actions-codespell@v2 with: uri_ignore_words_list: abandonned ``` @@ -117,7 +117,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. ```yml -uses: codespell-project/actions-codespell@v1 +uses: codespell-project/actions-codespell@v2 with: path: src ``` @@ -131,7 +131,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. ```yml -uses: codespell-project/actions-codespell@v1 +uses: codespell-project/actions-codespell@v2 with: only_warn: 1 ``` diff --git a/codespell-problem-matcher/action.yml b/codespell-problem-matcher/action.yml index 6d34e83..eb40b8d 100644 --- a/codespell-problem-matcher/action.yml +++ b/codespell-problem-matcher/action.yml @@ -2,7 +2,7 @@ name: 'codespell problem matcher' author: 'Peter Newman' description: 'Shows codespell errors as annotation (with file and code line) in GitHub Actions' runs: - using: 'node12' + using: 'node20' main: 'index.js' branding: icon: 'search'