Merge branch 'master' into patch-1

Author: larsoner

.github/dependabot.yml

@@ -0,0 +1,10 @@
+# See: https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#about-the-dependabotyml-file
+version: 2
+
+updates:
+  # Configure check for outdated GitHub Actions actions in workflows.
+  # See: https://docs.github.com/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot
+  - package-ecosystem: github-actions
+    directory: / # Check the repository's workflows under /.github/workflows/
+    schedule:
+      interval: daily

.github/workflows/publish_master.yml

@@ -13,7 +13,7 @@ jobs:
     name: Publish master image
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v5
     - name: Build
       run: |
         GITHUB_REPOSITORY_LC=$(echo "${GITHUB_REPOSITORY}" | tr [A-Z] [a-z])

.github/workflows/publish_stable.yml

@@ -10,7 +10,7 @@ jobs:
     name: Publish stable image
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v5
     - name: Build
       run: |
         GITHUB_REPOSITORY_LC=$(echo "${GITHUB_REPOSITORY}" | tr [A-Z] [a-z])

.github/workflows/testing.yml

@@ -19,13 +19,18 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v5
 
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.10'
 
       - name: Install codespell via pip using ${{ matrix.codespell_pip_version }}
-        run: pip3 --quiet --quiet install ${{ matrix.codespell_pip_version }}
+        run: pip install ${{ matrix.codespell_pip_version }}
+
+      - name: Check codespell
+        run: codespell --version
 
       - name: Install Bats
         run: |
@@ -43,7 +48,7 @@ jobs:
     name: Test run action
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v5
     - uses: ./
       with:
         path: test/testdata
@@ -53,13 +58,13 @@ jobs:
     name: Check for spelling errors
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v5
     - 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:
@@ -81,9 +86,9 @@ jobs:
         include:
           - codespell_pip_version: 'git+https://github.com/codespell-project/codespell.git'
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v5
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v6
       - run: pip3 --quiet --quiet install ${{ matrix.codespell_pip_version }}
       - run: |
           # Simulate the Dockerfile COPY command

.pre-commit-config.yaml

@@ -0,0 +1,8 @@
+repos:
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.4.1
+    hooks:
+      - id: codespell
+        args: [--ignore-words-list, "abandonned,ackward,bu"]
+        additional_dependencies:
+          - tomli

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.8-alpine
+FROM python:3.13-alpine
 
 COPY LICENSE \
         README.md \
@@ -7,7 +7,7 @@ COPY LICENSE \
         requirements.txt \
         /code/
 
-RUN pip install -r /code/requirements.txt
+RUN pip install --no-cache-dir -r /code/requirements.txt
 
 ENTRYPOINT ["/code/entrypoint.sh"]
 CMD []

README.md

@@ -5,9 +5,9 @@ Any warnings or errors will be annotated in the Pull Request.
 
 ## Usage
 
-```
+```yml
 - uses: actions/checkout@v5
-- uses: codespell-project/actions-codespell@master
+- uses: codespell-project/actions-codespell@v2
 ```
 
 ### Parameter: check_filenames
@@ -16,8 +16,8 @@ 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
+```yml
+uses: codespell-project/actions-codespell@v2
 with:
   check_filenames: true
 ```
@@ -28,8 +28,8 @@ 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.
 
-```
-uses: codespell-project/actions-codespell@master
+```yml
+uses: codespell-project/actions-codespell@v2
 with:
   check_hidden: true
 ```
@@ -40,8 +40,8 @@ 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
+```yml
+uses: codespell-project/actions-codespell@v2
 with:
   exclude_file: src/foo
 ```
@@ -52,8 +52,8 @@ 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
+```yml
+uses: codespell-project/actions-codespell@v2
 with:
   skip: foo,bar
 ```
@@ -62,10 +62,10 @@ with:
 
 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.
+This parameter is optional; by default `codespell` will use its default selection of built in dictionaries.
 
-```
-uses: codespell-project/actions-codespell@master
+```yml
+uses: codespell-project/actions-codespell@v2
 with:
   builtin: clear,rare
 ```
@@ -77,8 +77,8 @@ 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
+```yml
+uses: codespell-project/actions-codespell@v2
 with:
   ignore_words_file: .codespellignore
 ```
@@ -90,21 +90,35 @@ 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
+```yml
+uses: codespell-project/actions-codespell@v2
 with:
   ignore_words_list: abandonned,ackward
 ```
 
+### Parameter: uri_ignore_words_list
+
+Comma-separated list of words which will be ignored by `codespell` in URIs and emails only.
+Words are case sensitive based on how they are written in the dictionary file.
+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@v2
+with:
+  uri_ignore_words_list: abandonned
+```
+
 ### Parameter: path
 
 Indicates the path to run `codespell` in.
 This can be useful if your project has code you don't want to spell check for some reason.
 
 This parameter is optional; by default `codespell` will run on your whole repository.
 
-```
-uses: codespell-project/actions-codespell@master
+```yml
+uses: codespell-project/actions-codespell@v2
 with:
   path: src
 ```
@@ -117,8 +131,8 @@ 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: codespell-project/actions-codespell@master
+```yml
+uses: codespell-project/actions-codespell@v2
 with:
   only_warn: 1
 ```

action.yml

@@ -2,6 +2,10 @@ name: 'Codespell with annotations'
 author: 'Peter Newman'
 description: 'Codespell with annotations for Pull Request'
 inputs:
+  builtin:
+    description: 'Comma-separated list of builtin dictionaries to include'
+    required: false
+    default: ''
   check_filenames:
     description: 'If set, check file names as well'
     required: false
@@ -10,16 +14,12 @@ inputs:
     description: 'If set, check hidden files (those starting with ".") as well'
     required: false
     default: ''
-  exclude_file:
-    description: 'File with lines that should not be checked for spelling mistakes'
+  config:
+    description: 'Path to a codespell config file'
     required: false
     default: ''
-  skip:
-    description: 'Comma-separated list of files to skip (it accepts globs as well)'
-    required: false
-    default: './.git'
-  builtin:
-    description: 'Comma-separated list of builtin dictionaries to include'
+  exclude_file:
+    description: 'File with lines that should not be checked for spelling mistakes'
     required: false
     default: ''
   ignore_words_file:
@@ -30,10 +30,18 @@ inputs:
     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: ''
+  uri_ignore_words_list:
+    description: 'comma separated list of words to be ignored in URIs and emails only'
+    required: false
+    default: ''
   path:
     description: 'Path to run codespell in'
     required: false
     default: ''
+  skip:
+    description: 'Comma-separated list of files to skip (it accepts globs as well)'
+    required: false
+    default: './.git'
   only_warn:
     description: 'If set, only warn, never error'
     required: false

codespell-problem-matcher/.github/workflows/test.yml

@@ -25,7 +25,9 @@ jobs:
     steps:
     - name: Checkout
       uses: actions/checkout@master
-    - uses: actions/setup-python@v1
+    - uses: actions/setup-python@v4
+      with:
+        python-version:3.x
     - run: pip install git+https://github.com/codespell-project/codespell.git
     - uses: ./
     - name: Check codespell

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'