Skip to content

Commit

Permalink
Update spellcheck to the latest
Browse files Browse the repository at this point in the history
Signed-off-by: Tim Smith <[email protected]>
  • Loading branch information
tas50 committed Oct 18, 2023
1 parent 3aa6414 commit bfaa073
Show file tree
Hide file tree
Showing 8 changed files with 54 additions and 21 deletions.
3 changes: 2 additions & 1 deletion .github/actions/spelling/excludes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,5 @@ ignore$
\.webp$
\.woff2?$
\.zip$
^\.github/
^\.github/actions/spelling/
^\Q.github/workflows/spelling.yml\E$
11 changes: 10 additions & 1 deletion .github/actions/spelling/expect.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
.github/actions/spelling/expect.txtbuildx

Check warning on line 1 in .github/actions/spelling/expect.txt

View workflow job for this annotation

GitHub Actions / Run spell check

Ignoring entry because it contains non-alpha characters. (non-alpha-in-dictionary)
buildx
myapp
cla
codeql
dfd
healthz
myapp
nginx
notsigned
prcomment
readyz
softprops
31 changes: 26 additions & 5 deletions .github/actions/spelling/line_forbidden.patterns
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Detect common combinations of valid words that are in fact invalid.
# Detect common combinations of valid words that are in fact invalid.
# Useful for brand capitalizations

#
Expand All @@ -9,6 +9,10 @@
\sthe Mondoo Platform\b
\sMondoo platform\b

# s.b. Compliance Hub
\scompliance hub\b
\sCompliance hubplatform\b

#
# Industry Terms
#
Expand Down Expand Up @@ -44,6 +48,17 @@
# Product Names
#

# s.b. Jira
\bJIRA\b

# s.b. MariaDB
\bMaria DB\b
\bmariaDB\b
# \bmariaDb\b causes failures in MQL queries

# s.b. PostgreSQL
\bPostgreSql\b

# s.b. Firefox
\bFireFox\b

Expand Down Expand Up @@ -87,6 +102,7 @@

# s.b. Red Hat
\bRedHat\b
\bRedhat\b

# s.b. AlmaLinux
\bAlma Linux\b
Expand Down Expand Up @@ -159,6 +175,10 @@
\bVcenter\b
\bVCenter\b

# s.b. vSphere
\bVsphere\b
\bVSphere\b

# s.b. ESXi
\bEsxi\b

Expand Down Expand Up @@ -370,18 +390,17 @@
\bCloudBuild\b
\bCloud build\b

# disabled for now in this repo due to false positives
# s.b. Cloud Run
# \bCloudRun\b
# \bCloud run\b
\bCloudRun\b
\bCloud run\b

#
# Azure Products
#

# s.b. Key Vault
\bKey vault\b
# \bKeyVault\b # disabled for now in this repo due to false positives
\bKeyVault\b

# s.b. Ampere
\bampere\b
Expand Down Expand Up @@ -418,6 +437,8 @@

# s.b. Cosmos DB
\bCosmosDB\b
\bCosmoDB\b
\bCosmo DB\b

# s.b. SignalR Service
\bSignalR service\b
Expand Down
1 change: 1 addition & 0 deletions .github/actions/spelling/patterns.txt
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,4 @@ uid:\s.*$
aws_session_token\s+\=(\s+)?.+
aws_access_key_id\s+\=(\s+)?.+
aws_secret_access_key\s+\=(\s+)?.+

2 changes: 1 addition & 1 deletion .github/actions/spelling/reject.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ Sorce
^untilling$
^wether.*
\w*(?<!right-)click
press
press

Check warning on line 13 in .github/actions/spelling/reject.txt

View workflow job for this annotation

GitHub Actions / Run spell check

No newline at eof. (no-newline-at-eof)
7 changes: 4 additions & 3 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
- package-ecosystem: github-actions
directory: /
schedule:
interval: "weekly"
interval: weekly
6 changes: 3 additions & 3 deletions .github/workflows/spell-check.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ jobs:
steps:
- name: check-spelling
id: spelling
uses: check-spelling/[email protected].21
uses: check-spelling/[email protected].22
with:
suppress_push_for_open_pull_request: 1
checkout: true
post_comment: 0
dictionary_source_prefixes: '{"mondoo": "https://raw.githubusercontent.com/mondoohq/spellcheck-dictionary/main/", "cspell": "https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/"}'
dictionary_source_prefixes: '{"mondoo": "https://raw.githubusercontent.com/mondoohq/spellcheck-dictionary/main/", "cspell": "https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/"}'
extra_dictionaries: cspell:aws/aws.txt
cspell:filetypes/filetypes.txt
cspell:software-terms/src/software-terms.txt
Expand All @@ -46,7 +46,7 @@ jobs:
if: (success() || failure()) && needs.spelling.outputs.followup
steps:
- name: comment
uses: check-spelling/[email protected].21
uses: check-spelling/[email protected].22
with:
checkout: true
task: ${{ needs.spelling.outputs.followup }}
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,18 @@ To create a service account on Mondoo Platform:

1. Log in to [Mondoo Platform](https://console.mondoo.com)
2. Select the Space you want to integrate with your repository.
3. Click on **Settings** and then **Service Accounts**.
4. Click **ADD ACCOUNT**.
5. Select the **Base64-encoded** checkbox, and then click on the **GENERATE NEW CREDENTIALS** button.
3. Select **Settings** and then **Service Accounts**.
4. Select **ADD ACCOUNT**.
5. Select the **Base64-encoded** checkbox, and then select the **GENERATE NEW CREDENTIALS** button.
6. Copy the base64 encoded credentials and then move on to the next section.

### Add new GitHub Actions Secrets

1. Click on **Settings** in your GitHub repository.
2. Under the **Security** section click on **Actions**.
3. Click **New repository secret**.
1. Select **Settings** in your GitHub repository.
2. Under the **Security** section select **Actions**.
3. Select **New repository secret**.
4. Name the secret `MONDOO_SERVICE_ACCOUNT` and paste the base64 encoded credentials from the previous section into the value input.
5. Click **Add secret**.
5. Select **Add secret**.

## Examples Workflows

Expand Down

0 comments on commit bfaa073

Please sign in to comment.