Skip to content

Commit

Permalink
Preparing release 0.44.0
Browse files Browse the repository at this point in the history
  • Loading branch information
jonasbn committed Oct 25, 2024
1 parent e591a46 commit 986143f
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 16 deletions.
15 changes: 14 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,18 @@
# Change Log for spellcheck-github-actions

## 0.44.0, 2024-10-25, maintenance release, update not required

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

- Since lxml was not building I bumped to the lastest release 5.3.0. In in relation to that, so I while I was at it I went through the dependencies and updated the ones possible using a PySpelling build as the baseline. The following dependencies were updated:

- beautifulsoup4 bumped from version 4.12.2 to 4.12.3, see [release notes](https://git.launchpad.net/beautifulsoup/tree/CHANGELOG)
- lxml bumped from version 4.9.3 to 5.3.0, see [release notes](https://github.com/lxml/lxml/blob/master/CHANGES.txt)
- Markdown bumped from version 3.4.4 to 3.7, see [release notes](https://python-markdown.github.io/changelog/#37-2024-08-16)
- pymdown-extensions bumped from version 10.4 to 10.11.2, see [release notes](https://github.com/facelessuser/pymdown-extensions/releases/tag/10.11.2)
- PyYAML bumped from version 6.0.1 to 6.0.2, see [release notes](https://github.com/yaml/pyyaml/blob/main/CHANGES)
- soupsieve bumped from version 2.5 to 2.6, see [release notes](https://github.com/facelessuser/soupsieve/releases/tag/2.6)

## 0.43.1, 2024-10-17, bug fix release, update recommended

- This is an attempt at addressing the conflict between using the PySpelling `--source` parameter and the `sources` parameter in the PySpelling configuration file introduced by this action. With the recommendation of using the GitHub Action: [tj-actions/changed-files](https://github.com/marketplace/actions/changed-files), the use of the `--source` flag was adopted, but this bypasses the filtering mechanism, which can be enabled in the configuration file. The update recommendation is due to the fact that you might experience unwanted behaviour if your `sources` contain negated file patterns. The patch enables application of the configured filter to the source parameters, so the action can be used with the `--source` parameter and the `sources` configuration parameter in combination.
Expand Down Expand Up @@ -63,7 +76,7 @@ Bumping to Python 3.12.0 slim, introduced a number of dependency updates, not al
- beautifulsoup4 bumped from version 4.9.3 to 4.12.2, see [release notes](https://git.launchpad.net/beautifulsoup/tree/CHANGELOG)
- lxml bumped from version 4.9.2 to 4.9.3, see [release notes](https://github.com/lxml/lxml/blob/master/CHANGES.txt)
- Markdown bumped from version 3.3.4 to 3.4.4, see [release notes](https://python-markdown.github.io/changelog/#344-2023-07-25)
- pymdown-extension bumped from version 10.0.1 to 10.4, see [release notes](https://github.com/facelessuser/pymdown-extensions/releases/tag/10.4)
- pymdown-extensions bumped from version 10.0.1 to 10.4, see [release notes](https://github.com/facelessuser/pymdown-extensions/releases/tag/10.4)
- PyYAML bumped from version 5.4.1 to 6.0.1, see [release notes](https://github.com/yaml/pyyaml/blob/main/CHANGES)
- soupsieve bumped from version 2.2.1 to 2.5, see [release notes](https://github.com/facelessuser/soupsieve/releases/tag/2.5)

Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ jobs:
steps:
# The checkout step
- uses: actions/checkout@v3
- uses: rojopolis/spellcheck-github-actions@0.43.1
- uses: rojopolis/spellcheck-github-actions@0.44.0
name: Spellcheck
```
Expand All @@ -114,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.43.1`, 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.44.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 @@ -202,7 +202,7 @@ jobs:
steps:
# The checkout step
- uses: actions/checkout@v3
- uses: rojopolis/spellcheck-github-actions@0.43.1
- uses: rojopolis/spellcheck-github-actions@0.44.0
name: Spellcheck
with:
source_files: README.md CHANGELOG.md notes/Notes.md
Expand Down Expand Up @@ -230,7 +230,7 @@ jobs:
steps:
# The checkout step
- uses: actions/checkout@v3
- uses: rojopolis/spellcheck-github-actions@0.43.1
- uses: rojopolis/spellcheck-github-actions@0.44.0
name: Spellcheck
with:
source_files: README.md CHANGELOG.md notes/Notes.md
Expand Down Expand Up @@ -317,7 +317,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: rojopolis/spellcheck-github-actions@0.43.1
- uses: rojopolis/spellcheck-github-actions@0.44.0
name: Spellcheck
with:
config_path: config/.spellcheck.yml # put path to configuration file here
Expand Down Expand Up @@ -517,7 +517,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: rojopolis/spellcheck-github-actions@0.43.1
- uses: rojopolis/spellcheck-github-actions@0.44.0
name: Spellcheck
with:
config_path: .github/spellcheck.yml # <--- put path to configuration file here
Expand Down Expand Up @@ -758,7 +758,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: rojopolis/spellcheck-github-actions@0.43.1
- uses: rojopolis/spellcheck-github-actions@0.44.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.43.1'
image: 'docker://jonasbn/github-action-spellcheck:0.44.0'
14 changes: 7 additions & 7 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
backrefs==5.6
beautifulsoup4==4.12.2
bracex==2.1.1
beautifulsoup4==4.12.3
bracex==2.5.post1
html5lib==1.1
lxml==5.3.0
Markdown==3.4.4
pymdown-extensions==10.4
Markdown==3.7
pymdown-extensions==10.11.2
pyspelling==2.10
PyYAML==6.0.1
PyYAML==6.0.2
six==1.16.0
soupsieve==2.5
wcmatch>=8.5
soupsieve==2.6
wcmatch>=10.0
webencodings==0.5.1
zipp>=3.19.1 # not directly required, pinned by Snyk to avoid a vulnerability

0 comments on commit 986143f

Please sign in to comment.