Skip to content

Create check-spelling.yml #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

Create check-spelling.yml #5

wants to merge 12 commits into from

Conversation

garzarobm
Copy link
Contributor

No description provided.

Signed-off-by: Mike  <garzarobm@gmail.com>
@github-advanced-security
Copy link

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

@@ -0,0 +1,5 @@
- name: Check Spelling (JS, Vue, HTML, Markdown, Text)
# You may pin to the exact commit or the version.
# uses: UnicornGlobal/spellcheck-github-actions@729ccf160f6e72bd078904cddd5e6244f81ee156

Check failure

Code scanning / check-spelling

Unrecognized Spelling

[ccf](#security-tab) is not a recognized word. \(unrecognized-spelling\)
@@ -0,0 +1,5 @@
- name: Check Spelling (JS, Vue, HTML, Markdown, Text)
# You may pin to the exact commit or the version.
# uses: UnicornGlobal/spellcheck-github-actions@729ccf160f6e72bd078904cddd5e6244f81ee156

Check failure

Code scanning / check-spelling

Unrecognized Spelling

[cddd](#security-tab) is not a recognized word. \(unrecognized-spelling\)
@@ -0,0 +1,5 @@
- name: Check Spelling (JS, Vue, HTML, Markdown, Text)
# You may pin to the exact commit or the version.
# uses: UnicornGlobal/spellcheck-github-actions@729ccf160f6e72bd078904cddd5e6244f81ee156

Check failure

Code scanning / check-spelling

Unrecognized Spelling

[spellcheck](#security-tab) is not a recognized word. \(unrecognized-spelling\)
@@ -0,0 +1,5 @@
- name: Check Spelling (JS, Vue, HTML, Markdown, Text)

Check failure

Code scanning / check-spelling

Check File Path

[workflows](#security-tab) is not a recognized word. \(check-file-path\)
@@ -0,0 +1,5 @@
- name: Check Spelling (JS, Vue, HTML, Markdown, Text)

Check failure

Code scanning / check-spelling

Check File Path

[yml](#security-tab) is not a recognized word. \(check-file-path\)
@@ -0,0 +1,5 @@
- name: Check Spelling (JS, Vue, HTML, Markdown, Text)
# You may pin to the exact commit or the version.
# uses: UnicornGlobal/spellcheck-github-actions@729ccf160f6e72bd078904cddd5e6244f81ee156

Check warning

Code scanning / check-spelling

Candidate Pattern

[Line](#security-tab) matches candidate pattern "\\\buses:\\\s+[-\\\w.\]+/[-\\\w./\]+@[-\\\w.\]+" \(candidate-pattern\)
@@ -0,0 +1,5 @@
- name: Check Spelling (JS, Vue, HTML, Markdown, Text)
# You may pin to the exact commit or the version.
# uses: UnicornGlobal/spellcheck-github-actions@729ccf160f6e72bd078904cddd5e6244f81ee156

Check warning

Code scanning / check-spelling

Candidate Pattern

[Line](#security-tab) matches candidate pattern "\\\b[0-9a-fA-F\]{16,}\\\b" \(candidate-pattern\)
- name: Check Spelling (JS, Vue, HTML, Markdown, Text)
# You may pin to the exact commit or the version.
# uses: UnicornGlobal/spellcheck-github-actions@729ccf160f6e72bd078904cddd5e6244f81ee156
uses: UnicornGlobal/spellcheck-github-actions@0.4.0

Check failure

Code scanning / check-spelling

Unrecognized Spelling

[spellcheck](#security-tab) is not a recognized word. \(unrecognized-spelling\)
Copy link

@check-spelling-bot Report

🔴 Please review

See the 📂 files view, the 📜action log, or 📝 job summary for details.

Unrecognized words (57)
bootup
ccf
cddd
compabitibility
componennts
conjuction
dashcam
depedencies
dependecies
edgetpu
embeddings
ETODO
fef
globbing
google
gpio
gpiozero
hackable
linux
medthod
motioneye
ning
noreply
notifcation
pdf
picamera
pidash
pigpio
pigpiod
poweroff
pwm
PWMLED
pytest
raspberrypi
raspi
raspian
raspivid
recognises
ribben
Robjects
rpi
seperate
spellcheck
standalone
stefanzweifel
sucessfully
tada
tinkereres
TPU
uncompress
usb
Vue
website
workflows
xlsx
xvf
yml
Some files were automatically ignored 🙈

These sample patterns would exclude them:

^\QHardware/1.0-Set-up-pi-image\E$
^\Qsoftware/camera/record-10-secs/main.py\E$

You should consider adding them to:

.github/actions/spelling/excludes.txt

File matching is via Perl regular expressions.

To check these files, more of their words need to be in the dictionary than not. You can use patterns.txt to exclude portions, add items to the dictionary (e.g. by adding them to allow.txt), or fix typos.

To accept these unrecognized words as correct and update file exclusions, you could run the following commands

... in a clone of the git@github.com:Robjects-Pi/pi-dash.git repository
on the garzarobm-patch-1 branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/main/apply.pl' |
perl - 'https://github.com/Robjects-Pi/pi-dash/actions/runs/8232450788/attempts/1'

OR

To have the bot accept them for you, reply quoting the following line:
@check-spelling-bot apply updates.

Available 📚 dictionaries could cover words not in the 📘 dictionary
Dictionary Entries Covers Uniquely
cspell:npm/dict/npm.txt 302 4 1
cspell:filetypes/filetypes.txt 264 3 1
cspell:java/src/java-terms.txt 920 3
cspell:aws/aws.txt 218 2 2
cspell:r/src/r.txt 543 2 1

Consider adding them (in .github/workflows/spelling.yml) for uses: check-spelling/check-spelling@main in its with:

      with:
        extra_dictionaries:
          cspell:npm/dict/npm.txt
          cspell:filetypes/filetypes.txt
          cspell:java/src/java-terms.txt
          cspell:aws/aws.txt
          cspell:r/src/r.txt

To stop checking additional dictionaries, add (in .github/workflows/spelling.yml) for uses: check-spelling/check-spelling@main in its with:

check_extra_dictionaries: ''
Pattern suggestions ✂️ (5)

You could add these patterns to .github/actions/spelling/patterns.txt:

# Automatically suggested patterns
# hit-count: 5 file-count: 3
# https/http/file urls
(?:\b(?:https?|ftp|file)://)[-A-Za-z0-9+&@#/%?=~_|!:,.;]+[-A-Za-z0-9+&@#/%=~_|]

# hit-count: 4 file-count: 2
# GitHub actions
\buses:\s+[-\w.]+/[-\w./]+@[-\w.]+

# hit-count: 2 file-count: 2
# GitHub SHAs (markdown)
(?:\[`?[0-9a-f]+`?\]\(https:/|)/(?:www\.|)github\.com(?:/[^/\s"]+){2,}(?:/[^/\s")]+)(?:[0-9a-f]+(?:[-0-9a-zA-Z/#.]*|)\b|)

# hit-count: 2 file-count: 2
# hex runs
\b[0-9a-fA-F]{16,}\b

# hit-count: 1 file-count: 1
# tar arguments
\b(?:\\n|)g?tar(?:\.exe|)(?:(?:\s+--[-a-zA-Z]+|\s+-[a-zA-Z]+|\s[ABGJMOPRSUWZacdfh-pr-xz]+\b)(?:=[^ ]*|))+

Errors (4)

See the 📂 files view, the 📜action log, or 📝 job summary for details.

❌ Errors Count
ℹ️ binary-file 2
ℹ️ candidate-pattern 10
❌ check-file-path 13
❌ forbidden-pattern 1

See ❌ Event descriptions for more information.

Signed-off-by: Mike  <garzarobm@gmail.com>
Signed-off-by: Mike  <garzarobm@gmail.com>
Signed-off-by: Mike  <garzarobm@gmail.com>
Signed-off-by: Mike  <garzarobm@gmail.com>
Signed-off-by: Mike  <garzarobm@gmail.com>
Signed-off-by: Mike  <garzarobm@gmail.com>
Signed-off-by: Mike  <garzarobm@gmail.com>
Signed-off-by: Mike  <garzarobm@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant