Skip to content

Commit

Permalink
Dependencies and docker multi stage (#54)
Browse files Browse the repository at this point in the history
* Updated requirements and prepared for release 0.15.0. With the update to pyspelling, the wordlist could be reduced significantly

* Corrected spelling error

* Added missing special words to local dictionary

* Added pre-commit hooks, so I do not commit spelling errors (if possible)

* Pre-commit hooks cleaned one of the YAML files

* Examples updated to version 0.15.0, preparing release 0.15.0
  • Loading branch information
jonasbn committed Aug 15, 2021
1 parent 79f16ca commit 8d01ffe
Show file tree
Hide file tree
Showing 8 changed files with 122 additions and 100 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/markdownlint.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@

name: Markdownlint Action
on: push

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/spelling_action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ jobs:
steps:
# The checkout step
- uses: actions/checkout@master
- uses: rojopolis/spellcheck-github-actions@0.14.0
- uses: rojopolis/spellcheck-github-actions@0.15.0
name: Spellcheck
with:
source_files: README.md CHANGELOG.md
Expand Down
20 changes: 20 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# See https://pre-commit.com for more information
# See https://pre-commit.com/hooks.html for more hooks
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v3.2.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
- id: check-yaml
- id: check-added-large-files
- id: no-commit-to-branch
- repo: https://github.com/jonasbn/pre-commit-hooks
rev: v0.5.0
hooks:
- id: spellcheck
- repo: https://github.com/igorshubovych/markdownlint-cli
rev: v0.27.1
hooks:
- id: markdownlint
name: "Checking Markdown with markdownlint"
27 changes: 27 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,32 @@
# Change Log for spellcheck-github-actions

## 0.15.0 2021-08-13 maintenance release, update not required

Issue [#53](https://github.com/rojopolis/spellcheck-github-actions/issues/53) describes an issue with ignoring Markdown regions with code fences. This was an issue in `pyspelling`, which is the core component in this action. Luckily @facelessuser, the maintainer of `pyspelling` was to [fix it](https://github.com/facelessuser/pyspelling/pull/144). So the requirement for `pyspelling` was bumped from 2.6.1 to 2.7.3

Thanks to @supernovae and @facelessuser

This however demonstrated that several of the dependencies was not up to date.

'The following dependencies have been updated:

- [backrefs](https://pypi.org/project/backrefs/) updated from 4.5 to 5.0.1
- [bracex](https://pypi.org/project/bracex/) updated from 2.0.1 to 2.1.1
- [lxml](https://pypi.org/project/lxml/) updated from 4.6.0 to 4.6.3
- [Markdown](https://pypi.org/project/Markdown/) updated from 3.3.1 to 3.3.4
- [pymdown-extensions](https://pypi.org/project/pymdown-extensions/) updated from 8.1 to 8.2
- [pyspelling](https://pypi.org/project/pyspelling/) updated from 2.6.1 to 2.7.3
- [PyYAML](https://pypi.org/project/PyYAML/) updated from 5.3.1 to 5.4.1
- [six](https://pypi.org/project/six/) updated from 1.15.0 to 1.16.0
- [soupsieve](https://pypi.org/project/soupsieve/) updated from 2.0.1 to 2.2.1
- [wcmatch](https://pypi.org/project/wcmatch/) updated from 7.1 to 8.2

Additionally some work has been done in regard to the Docker build, so it is possible to specify new languages, using multi-stage build, see PR [#39](https://github.com/rojopolis/spellcheck-github-actions/pull/39) addressing issue: [#13](https://github.com/rojopolis/spellcheck-github-actions/issues/13)

Please see [the Wiki](https://github.com/rojopolis/spellcheck-github-actions/wiki/Development) for details.

Thanks to @aSemy and @edumco

## 0.14.0 2021-05-13 maintenance release, update not required

- Docker image updated to Python 3.9.5 slim via PR [#48](https://github.com/rojopolis/spellcheck-github-actions/pull/48) from dependabot
Expand Down
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ jobs:
steps:
# The checkout step
- uses: actions/checkout@master
- uses: rojopolis/spellcheck-github-actions@0.14.0
- uses: rojopolis/spellcheck-github-actions@0.15.0
name: Spellcheck
```
Expand Down Expand Up @@ -77,7 +77,7 @@ jobs:
steps:
# The checkout step
- uses: actions/checkout@master
- uses: rojopolis/spellcheck-github-actions@0.14.0
- uses: rojopolis/spellcheck-github-actions@0.15.0
name: Spellcheck
with:
source_files: README.md CHANGELOG.md notes/Notes.md
Expand Down Expand Up @@ -150,7 +150,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: rojopolis/spellcheck-github-actions@0.14.0
- uses: rojopolis/spellcheck-github-actions@0.15.0
name: Spellcheck
with:
config_path: config/.spellcheck.yml # put path to configuration file here
Expand Down Expand Up @@ -291,7 +291,7 @@ Additional languages can be added by request, please open an issue.

[Hunspell][hunspell] is supported by [PySpelling][pyspelling], but is **not** currently supported by this action

Please open an issue, [Hunspell][hunspell] should be evaluated for inclusion.
Please open an issue or PR, if [Hunspell][hunspell] should be evaluated for possible inclusion.

## Tips

Expand Down Expand Up @@ -383,7 +383,7 @@ This diagnostic indicates that the configuration file pointed to with the `--con

Indicates: `spellcheck.yaml` so this file should exist in the repository.

If the file is available in the repository, please check that your workflow is configured correctly, with the following line, which enables [the action Checkout][actioncheckout].
If the file is available in the repository, please check that your workflow is configured correctly, with the following line, which enables [the action: checkout][actioncheckout].

`uses: actions/checkout@master`

Expand All @@ -399,7 +399,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: rojopolis/spellcheck-github-actions@0.14.0
- uses: rojopolis/spellcheck-github-actions@0.15.0
name: Spellcheck
```

Expand Down Expand Up @@ -485,12 +485,14 @@ The original author of this GitHub Action is Robert Jordan (@rojopolis)

Here follows a list of contributors in alphabetical order:

- Pavel Skipenes, @pavelskipenes
- @aSemy
- Albert Volkman, @albertvolkman
- Byron Miller, @supernovae
- Isaac Muse, @facelessuser
- Jonas Brømsø, @jonasbn
- José Eduardo Montenegro Cavalcanti de Oliveira, @edumco
- Michael Flaxman, @mflaxman
- Pavel Skipenes, @pavelskipenes
- Stephen Bates, @sbates130272

Do you want to be left out, or feel left out of this list or have a different representation of your name, please submit a pull request or raise an issue
Expand Down
20 changes: 10 additions & 10 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
backrefs==4.5
backrefs==5.0.1
beautifulsoup4==4.9.3
bracex==2.0.1
bracex==2.1.1
html5lib==1.1
lxml==4.6.0
pyspelling==2.6.1
PyYAML==5.3.1
six==1.15.0
soupsieve==2.0.1
wcmatch==7.1
lxml==4.6.3
Markdown==3.3.4
pymdown-extensions==8.2
pyspelling==2.7.3
PyYAML==5.4.1
six==1.16.0
soupsieve==2.2.1
wcmatch==8.2
webencodings==0.5.1
markdown==3.3.1
pymdown-extensions==8.1
2 changes: 1 addition & 1 deletion spellcheck.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
matrix:
- name: Markdown
sources:
- '**/*.md'
- '!venv/**/*.md|**/*.md'
default_encoding: utf-8
aspell:
lang: en
Expand Down
133 changes: 53 additions & 80 deletions wordlist.txt
Original file line number Diff line number Diff line change
@@ -1,93 +1,66 @@
aspell
cd
dic
Dockerfile
docstrings
Arithmatex
BetterEm
Brømsø
CHANGELOG
Cavalcanti
Customizable
DockerHub
EscapeAll
Flaxman
Github
InlineHilite
José
MagicLink
Oliveira
PathConverter
Pavel
ProgressBar
PyPi
PySpelling
README
SaneHeaders
Skipenes
SmartSymbols
StripHTML
SuperFences
Tasklist
Volkman
Wordlist
YAML
albertvolkman
codefences
config
de
dependabot
edumco
entrypoint
ENTRYPOINT
facelessuser
fu
faq
github
gmail
html
https
io
lang
jonasbn
linters
md
PWD
py
pyspelling
PySpelling
tmp
txt
utf
wordlist
wordlists
yaml
yml
README
toolchain
Errno
FileNotFoundError
RuntimeError
mkdn
mflaxman
pavelskipenes
pre
pyspelling
rojopolis
sbates
Customizable
DockerHub
jonasbn
Cavalcanti
José
Oliveira
de
edumco
Brømsø
Volkman
albertvolkman
linters
ValueError
config
sexualized
socio
toolchain
ubuntu
lxml
www
yaml
yml
backrefs
beautifulsoup
bracex
lxml
pymdown
PyYAML
soupsieve
wcmatch
Flaxman
mflaxman
dependabot
Pavel
Skipenes
pavelskipenes
PyPi
faq
www
gmail
codefences
socio
sexualized
Arithmatex
B64
BetterEm
Caret
Critic
Details
Emoji
EscapeAll
Extra
Highlight
InlineHilite
Keys
MagicLink
Mark
PathConverter
ProgressBar
SaneHeaders
SmartSymbols
Snippets
StripHTML
SuperFences
Tabbed
Tasklist
Tilde
CHANGELOG
aSemy

0 comments on commit 8d01ffe

Please sign in to comment.