Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# Change Log for spellcheck-github-actions

## 0.62.0, 2026-06-19, security release, update recommended

- Bumped `lxml` from 5.3.0 to 5.4.0 to address known CVEs via PR [#357](https://github.com/rojopolis/spellcheck-github-actions/pull/357).

- Bumped `pymdown-extensions` to patched version 10.21.3 via PR [#358](https://github.com/rojopolis/spellcheck-github-actions/pull/358).

- Bumped `Markdown` from 3.7 to 3.8.1 to patched version via PR [#359](https://github.com/rojopolis/spellcheck-github-actions/pull/359).

- Cleaned up GitHub Actions workflows using `zizmor` and removed ratchet annotations via PR [#355](https://github.com/rojopolis/spellcheck-github-actions/pull/355) and PR [#356](https://github.com/rojopolis/spellcheck-github-actions/pull/356).

- Clarified examples in README.

## 0.61.0, 2026-06-14, minor feature release, update not required

- Docker based image updated for Python 3.14.5 slim trixie via PR [#344](https://github.com/rojopolis/spellcheck-github-actions/pull/344) from Dependabot.
Expand Down
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ jobs:
persist-credentials: false

- name: Spellcheck
uses: rojopolis/spellcheck-github-actions@0.61.0
uses: rojopolis/spellcheck-github-actions@0.62.0
```

This configuration file must be created in a the `.github/workflows/` directory.
Expand Down Expand Up @@ -230,7 +230,7 @@ jobs:
persist-credentials: false

- name: Spellcheck
uses: rojopolis/spellcheck-github-actions@0.61.0
uses: rojopolis/spellcheck-github-actions@0.62.0
with:
source_files: README.md CHANGELOG.md notes/Notes.md
task_name: Markdown
Expand Down Expand Up @@ -265,7 +265,7 @@ jobs:
persist-credentials: false

- name: Spellcheck
uses: rojopolis/spellcheck-github-actions@0.61.0
uses: rojopolis/spellcheck-github-actions@0.62.0
with:
source_files: README.md CHANGELOG.md notes/Notes.md
task_name: Markdown
Expand Down Expand Up @@ -374,11 +374,11 @@ jobs:
persist-credentials: false

- name: Spellcheck
uses: rojopolis/spellcheck-github-actions@0.61.0
uses: rojopolis/spellcheck-github-actions@0.62.0
with:
config_path: config/.spellcheck.yml # put path to configuration file here
source_files: source/scanning.md source/triggers.md
task_name: Markdown
config_path: config/.spellcheck.yml # put path to configuration file here
source_files: source/scanning.md source/triggers.md
task_name: Markdown
```

### Predefined Name
Expand Down Expand Up @@ -505,7 +505,7 @@ The action can be specified to use `hunspell` instead of `aspell` by setting the

```yaml
- name: Spellcheck
uses: rojopolis/spellcheck-github-actions@0.61.0
uses: rojopolis/spellcheck-github-actions@0.62.0
with:
task_name: Markdown
spell_checker: hunspell
Expand Down Expand Up @@ -620,10 +620,10 @@ jobs:
persist-credentials: false

- name: Spellcheck
uses: rojopolis/spellcheck-github-actions@0.61.0
uses: rojopolis/spellcheck-github-actions@0.62.0
with:
config_path: .github/spellcheck.yml
skip_dict_compile: true # <--- set to true to skip custom dictionary compilation
config_path: .github/spellcheck.yml
skip_dict_compile: true # <--- set to true to skip custom dictionary compilation
```

This can be useful if you have a large custom dictionary that does not change often, as it can save time during the action run.
Expand Down Expand Up @@ -660,9 +660,9 @@ jobs:
persist-credentials: false

- name: Spellcheck
uses: rojopolis/spellcheck-github-actions@0.61.0
uses: rojopolis/spellcheck-github-actions@0.62.0
with:
config_path: .github/spellcheck.yml # <--- put path to configuration file here
config_path: .github/spellcheck.yml # <--- put path to configuration file here
```

```yaml
Expand Down Expand Up @@ -909,7 +909,7 @@ jobs:
persist-credentials: false

- name: Spellcheck
uses: rojopolis/spellcheck-github-actions@0.61.0
uses: rojopolis/spellcheck-github-actions@0.62.0
```

This step adds an action, which checkout out the repository for inspection by linters and other actions like this one.
Expand Down
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ branding:
icon: type
runs:
using: docker
image: 'docker://jonasbn/github-action-spellcheck:0.61.0'
image: 'docker://jonasbn/github-action-spellcheck:0.62.0'
1 change: 1 addition & 0 deletions wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ Arithmatex
BetterEm
Brømsø
CVE
CVEs
CWE
Cavalcanti
Customizable
Expand Down