Skip to content

Commit

Permalink
Additional spellcheck updates (#66)
Browse files Browse the repository at this point in the history
Catch more.

Signed-off-by: Tim Smith <tsmith84@gmail.com>
  • Loading branch information
tas50 authored Apr 2, 2024
1 parent 444194f commit d9b514f
Show file tree
Hide file tree
Showing 5 changed files with 139 additions and 37 deletions.
35 changes: 34 additions & 1 deletion .github/actions/spelling/excludes.txt
Original file line number Diff line number Diff line change
@@ -1,50 +1,83 @@
# See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-excludes
(?:^|/)(?i)COPYRIGHT
(?:^|/)(?i)LICEN[CS]E
(?:^|/)3rdparty/
(?:^|/)go\.sum$
(?:^|/)package(?:-lock|)\.json$
(?:^|/)Pipfile$
(?:^|/)pyproject.toml
(?:^|/)requirements(?:-dev|-doc|-test|)\.txt$
(?:^|/)vendor/
ignore$
\.a$
\.ai$
\.all-contributorsrc$
\.avi$
\.bmp$
\.bz2$
\.cer$
\.class$
\.coveragerc$
\.crl$
\.crt$
\.csr$
\.dll$
\.docx?$
\.drawio$
\.DS_Store$
\.eot$
\.eps$
\.exe$
\.gif$
\.git-blame-ignore-revs$
\.gitattributes$
\.gitkeep$
\.graffle$
\.gz$
\.icns$
\.ico$
\.ipynb$
\.jar$
\.jks$
\.jpe?g$
\.key$
\.lib$
\.lock$
\.map$
\.min\..
\.mo$
\.mod$
\.mp[34]$
\.o$
\.ocf$
\.otf$
\.p12$
\.parquet$
\.pdf$
\.pem$
\.pfx$
\.png$
\.psd$
\.pyc$
\.pylintrc$
\.qm$
\.s$
\.svg$
\.sig$
\.so$
\.svgz?$
\.sys$
\.tar$
\.tgz$
\.tiff?$
\.ttf$
\.wav$
\.webm$
\.webp$
\.woff2?$
\.xcf$
\.xlsx?$
\.xpm$
\.xz$
\.zip$
^\.github/actions/spelling/
^\Q.github/workflows/spelling.yml\E$
93 changes: 67 additions & 26 deletions .github/actions/spelling/line_forbidden.patterns
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,29 @@
# Useful for brand capitalizations

#
# Catch placeholder text
#

\b[Ll]orem [Ii]psum\b

# Terms to avoid
#

# s.b. Allow list
\swhitelist\b
\swhitelisting\b
\swhitelisted\b
\swhite list\b
\swhite listing\b
\swhite listed\b
\s[Ww]hitelist\b
\s[Ww]hitelisting\b
\s[Ww]hitelisted\b
\s[Ww]hite list\b
\s[Ww]hite listing\b
\s[Ww]hite listed\b

# s.b. Block list
\sblacklist\b
\sblacklisting\b
\sblacklisted\b
\sblack list\b
\sblack listing\b
\sblack listed\b
\s[Bb]lacklist\b
\s[Bb]lacklisting\b
\s[Bb]lacklisted\b
\s[Bb]lack list\b
\s[Bb]lack listing\b
\s[Bb]lack listed\b

#
# Our Terms
Expand All @@ -30,43 +35,51 @@
\sMondoo platform\b

# s.b. Compliance Hub
\scompliance hub\b
\sCompliance hubplatform\b
\s[Cc]ompliance hub\b

#
# Compliance Terms
#

# s.b. SOC 2
\bSOC2\b

# s.b. ISO 270001
\bISO270001\b

#
# Industry Terms
#

# s.b. Side scanning
\bSidescanning\b
\bsidescanning\b
\b[Ss]idescanning\b

# s.b. DevOps
\bDev Ops\b
\bDevops\b

# s.b. SaaS
\bSaas\b
\bsaas\b
\b[Ss]aas\b

# s.b. Docker Hub
\bDockerHub\b
\bDockerhub\b
\bDocker[Hh]ub\b

# s.b. REST API
\bRest API\b
\brest API\b
\b[Rr]est API\b
\brest api\b

# s.b. DevSecOps
\bDevsecops\b
\bDevsec[Oo]ps\b

# s.b. on-premises
\bon-premise\b

# s.b. email
\be-mail\b

# s.b. APIs
\bapis\b

#
# Product Names
#
Expand Down Expand Up @@ -169,11 +182,24 @@
\bopenSSL\b

# s.b. CloudBees
\bCloudbees\b
\b[Cc]loudbees\b

# s.b. System76
\bSystem 76\b

# s.b. VirtualBox
\b[Vv]irtualbox\b
\bVirtual Box\b

# s.b. SentinelOne
\bSentinal[Oo]ne\b
\bSentinelone\b
\bSentinal One\b

# s.b. CrowdStrike
\bCrowd Strike\b
\b[Cc]rowdstrike\b

#
# HashiCorp Products
#
Expand All @@ -184,6 +210,10 @@
# s.b. Terraform
\bTerraForm\b

# s.b. Vagrantfile
\bVagrant file\b
\bVagrantFile\b

#
# Microsoft Products
#
Expand Down Expand Up @@ -277,8 +307,7 @@
\bCloudfront\b

# s.b. CloudHSM
\bCloudHsm\b
\bCloudhsm\b
\bCloud[Hh]sm\b

# s.b. CloudSearch
\bCloudsearch\b
Expand Down Expand Up @@ -315,6 +344,9 @@
# s.b. CodeStar
\bCodestar\b

# s.b. AWS Config
\bAWS config\b

# s.b. Copilot
\bCoPilot\b

Expand Down Expand Up @@ -605,3 +637,12 @@
# Reject duplicate words
\s([A-Z]{3,}|[A-Z][a-z]{2,}|[a-z]{3,})\s\g{-1}\s

# s.b. it's or its
\bits['’]

# s.b. understand
\bunder stand\b

# find spaces before a comma
# Enable this once https://github.com/check-spelling/check-spelling/wiki/Feature%3A-Block-Ignore ships
# ( )+,
37 changes: 32 additions & 5 deletions .github/actions/spelling/patterns.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@
\b([A-Za-z])\g{-1}{3,}\b

# ignore funky space IDs that blow up spell checking
api\.mondoo\.app\/space.*\b
console\.mondoo\.com\/space.*\b
api\.mondoo\.app\/.*\b
console\.mondoo\.com\/.*\b

# azure subscription ID
[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}
Expand All @@ -39,7 +39,7 @@ Key Vault Vault
\broot root\b

# AWS resources
(ami|subnet|vpc|sg)-[0-9a-fA-F]{17}
(ami|subnet|vpc|sg|fs)-[0-9a-fA-F]{17}

# http and https URLs
https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_\+.~#?&//=]*)
Expand All @@ -53,8 +53,8 @@ HKEY_[\w\\]*
# mime types
\bapplication\/\S*

# skip mql uids
uid:\s.*$
# mql certificate IDs
certificate:\w*

# ARN values
\barn:\S*
Expand Down Expand Up @@ -89,3 +89,30 @@ aws_secret_access_key\s+\=(\s+)?.+

# score score is valid in MQL docs
score score

# macOS temp folders
/var/folders/\w\w/[+\w]+/(?:T|-Caches-)/

# ssh
(?:ssh-\S+|-nistp256) [-a-zA-Z=;:\/0-9+]{12,}

# kubernetes object suffix
-[0-9a-f]{10}-\w{5}\s

# sed regular expressions
sed 's/(?:[^/]*?[a-zA-Z]{3,}[^/]*?/){2}

# UNIX device paths
\/dev\/\w*

# AWS RDS instance types
db.\w{2}.\w*

# uuid
[<({"'>][0-9a-fA-F]{8}-(?:[0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[<'"})>]

# rsa private keys
MII[BCEJ]\w*

# UID in MQL policy
- uid: \S*
1 change: 1 addition & 0 deletions .github/actions/spelling/reject.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
ad-hoc
^attache$
^bellow$
benefitting
occurences?
^dependan.*
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/cla.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ jobs:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
PERSONAL_ACCESS_TOKEN: ${{ secrets.CLA_ACCESS_TOKEN }}
with:
path-to-signatures: 'signatures/version1/cla.json'
path-to-document: 'https://github.com/mondoohq/.github/blob/master/CLA.md'
custom-pr-sign-comment: 'I have read the Mondoo CLA Document and I hereby sign the CLA'
custom-notsigned-prcomment: 'Thank you for your submission, we really appreciate it. Before we can accept your contribution, we ask that you sign the [Mondoo Contributor License Agreement](https://github.com/mondoohq/.github/blob/master/CLA.md). You can sign the CLA by adding a new comment to this pull request and pasting exactly the following text.'
path-to-signatures: "signatures/version1/cla.json"
path-to-document: "https://github.com/mondoohq/.github/blob/master/CLA.md"
custom-pr-sign-comment: "I have read the Mondoo CLA Document and I hereby sign the CLA"
custom-notsigned-prcomment: "Thank you for your submission. We really appreciate it. Before we can accept your contribution, we ask that you sign the [Mondoo Contributor License Agreement](https://github.com/mondoohq/.github/blob/master/CLA.md). You can sign the CLA by adding a new comment to this pull request and pasting exactly the following text."
remote-repository-name: cla
remote-organization-name: mondoohq
branch: 'main'
branch: "main"
allowlist: mondoo-tools,github-actions[bot],dependabot[bot]

0 comments on commit d9b514f

Please sign in to comment.