forked from rojopolis/spellcheck-github-actions
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
70 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,7 @@ | ||
FROM python:3.7 | ||
FROM python:3.7-alpine3.10 | ||
|
||
LABEL "com.github.actions.name"="Spellcheck Action" | ||
LABEL "com.github.actions.description"="Check spelling of files in repo" | ||
LABEL "com.github.actions.icon"="clipboard" | ||
LABEL "com.github.actions.color"="green" | ||
LABEL "repository"="http://github.com/rojopolis/spellcheck-github-actions" | ||
LABEL "homepage"="http://github.com/actions" | ||
LABEL "maintainer"="rojopolis <[email protected]>" | ||
LABEL "repository"="https://github.com/UnicornGlobal/spellcheck-github-actions" | ||
LABEL "homepage"="https://github.com/actions" | ||
|
||
RUN apt-get update && apt-get install -y \ | ||
aspell \ | ||
|
@@ -15,4 +10,4 @@ RUN pip3 install pyspelling | |
COPY entrypoint.sh /entrypoint.sh | ||
COPY spellcheck.yaml /spellcheck.yaml | ||
COPY wordlist.txt /wordlist.txt | ||
ENTRYPOINT ["/entrypoint.sh"] | ||
ENTRYPOINT ["/entrypoint.sh"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,17 @@ | ||
# spellcheck-github-actions | ||
A Github Action that spell checks Python, Markdown, and Text files. | ||
|
||
A Github Action that spell checks JavaScript, Vue, Markdown, HTML, and Text files. | ||
|
||
This action uses [PySpelling](https://facelessuser.github.io/pyspelling/) to | ||
check source files in the project. | ||
|
||
## Configuration | ||
|
||
If your repo contains `spellcheck.yaml` it will be used instead of the default config. | ||
See https://facelessuser.github.io/pyspelling/configuration/ for options. | ||
See https://facelessuser.github.io/pyspelling/configuration/ for options. | ||
|
||
## Upstream | ||
|
||
Based on `rojopolis/spellcheck-github-actions` | ||
|
||
That repo was not working for us so we made this fork |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
name: "Check Spelling (JS, Vue, HTML, Markdown, Text)" | ||
description: "Check spelling in a repo" | ||
branding: | ||
icon: "info" | ||
color: "yellow" | ||
outputs: | ||
changed: | ||
description: "Check code files for spelling errors" | ||
runs: | ||
using: "docker" | ||
image: "Dockerfile" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,12 @@ | ||
#!/bin/bash | ||
if [ ! -f ./spellcheck.yaml ]; then | ||
echo "spellcheck.yaml not found, using default\n" | ||
cp /spellcheck.yaml . | ||
fi | ||
|
||
if [ ! -f ./wordlist.txt ]; then | ||
echo "wordlist.txt not found, using default\n" | ||
cp /wordlist.txt . | ||
fi | ||
|
||
pyspelling -c spellcheck.yaml | ||
pyspelling -c spellcheck.yaml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters