Skip to content

Commit

Permalink
Preparing release 0.37.0
Browse files Browse the repository at this point in the history
  • Loading branch information
jonasbn committed Jun 1, 2024
1 parent aba445e commit e36f662
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 9 deletions.
8 changes: 7 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
# Change Log for spellcheck-github-actions

## 0.37.0, 2024-01-01, maintenance release, update not required

- Docker image updated to Python 3.12.3 slim via PR [#199](https://github.com/rojopolis/spellcheck-github-actions/pull/199) from Dependabot. [Release notes for Python 3.12.3](https://docs.python.org/release/3.12.3/whatsnew/changelog.html)

- Docker image updated to Python 3.12.2 slim via PR [#197](https://github.com/rojopolis/spellcheck-github-actions/pull/197) from Dependabot. [Release notes for Python 3.12.2](https://docs.python.org/release/3.12.2/whatsnew/changelog.html)

## 0.36.0, 2024-02-06, feature release, update not required

- With version 2.10 of **PySpelling** the action now supports the configuration of running jobs in parallel, see the [documentation for PySpelling](https://facelessuser.github.io/pyspelling/configuration/)

- Docker image updated to Python 3.12.1 slim via PR [#177](https://github.com/rojopolis/spellcheck-github-actions/pull/191) from Dependabot. [Release notes for Python 3.12.1](https://docs.python.org/release/3.12.1/whatsnew/changelog.html)
- Docker image updated to Python 3.12.1 slim via PR [#191](https://github.com/rojopolis/spellcheck-github-actions/pull/191) from Dependabot. [Release notes for Python 3.12.1](https://docs.python.org/release/3.12.1/whatsnew/changelog.html)

## 0.35.0, 2023-11-16, maintenance release, update not required

Expand Down
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ This action uses [PySpelling][pyspelling] to check spelling in source files in t
- [Extra Configuration for Markdown](#extra-configuration-for-markdown)
- [Spellcheck Configuration File](#spellcheck-configuration-file)
- [Predefined Name](#predefined-name)
- [Specifying Number of Jobs for Parallel Processing](#specifying-number-of-jobs-for-parallel-processing)
- [Specifying Language](#specifying-language)
- [Checking For Bad Spelling](#checking-for-bad-spelling)
- [Language Support](#language-support)
Expand Down Expand Up @@ -103,7 +104,7 @@ jobs:
steps:
# The checkout step
- uses: actions/checkout@v3
- uses: rojopolis/spellcheck-github-actions@0.36.0
- uses: rojopolis/spellcheck-github-actions@0.37.0
name: Spellcheck
```
Expand All @@ -113,7 +114,7 @@ For example, it could be named `.github/workflows/spelling_action.yml` for easy

### Using a Canonical Version

In the above example, the configuration is pointing to the exact version of `0.36.0`, this repository also offers the canonical version `v0`, so there is less hassle keeping the action up to date.
In the above example, the configuration is pointing to the exact version of `0.37.0`, this repository also offers the canonical version `v0`, so there is less hassle keeping the action up to date.

```yaml
name: Spellcheck Action
Expand Down Expand Up @@ -201,7 +202,7 @@ jobs:
steps:
# The checkout step
- uses: actions/checkout@v3
- uses: rojopolis/spellcheck-github-actions@0.36.0
- uses: rojopolis/spellcheck-github-actions@0.37.0
name: Spellcheck
with:
source_files: README.md CHANGELOG.md notes/Notes.md
Expand Down Expand Up @@ -229,7 +230,7 @@ jobs:
steps:
# The checkout step
- uses: actions/checkout@v3
- uses: rojopolis/spellcheck-github-actions@0.36.0
- uses: rojopolis/spellcheck-github-actions@0.37.0
name: Spellcheck
with:
source_files: README.md CHANGELOG.md notes/Notes.md
Expand Down Expand Up @@ -316,7 +317,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: rojopolis/spellcheck-github-actions@0.36.0
- uses: rojopolis/spellcheck-github-actions@0.37.0
name: Spellcheck
with:
config_path: config/.spellcheck.yml # put path to configuration file here
Expand Down Expand Up @@ -516,7 +517,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: rojopolis/spellcheck-github-actions@0.36.0
- uses: rojopolis/spellcheck-github-actions@0.37.0
name: Spellcheck
with:
config_path: .github/spellcheck.yml # <--- put path to configuration file here
Expand Down Expand Up @@ -731,7 +732,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: rojopolis/spellcheck-github-actions@0.36.0
- uses: rojopolis/spellcheck-github-actions@0.37.0
name: Spellcheck
```

Expand Down
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ branding:
icon: type
runs:
using: docker
image: 'docker://jonasbn/github-action-spellcheck:0.36.0'
image: 'docker://jonasbn/github-action-spellcheck:0.37.0'

0 comments on commit e36f662

Please sign in to comment.