From 8c19457246537a31e624f6d8dfcd27180f396aa0 Mon Sep 17 00:00:00 2001 From: Tim Smith Date: Fri, 25 Oct 2024 08:57:25 -0700 Subject: [PATCH] Sync over the latest and greatest spellcheck config (#64) --- .../actions/spelling/line_forbidden.patterns | 85 +++++++++++++++---- .github/actions/spelling/reject.txt | 1 + .github/workflows/cla.yaml | 15 ++-- .github/workflows/spell-check.yaml | 6 +- 4 files changed, 79 insertions(+), 28 deletions(-) diff --git a/.github/actions/spelling/line_forbidden.patterns b/.github/actions/spelling/line_forbidden.patterns index 20dbc91..c610e6a 100644 --- a/.github/actions/spelling/line_forbidden.patterns +++ b/.github/actions/spelling/line_forbidden.patterns @@ -7,36 +7,47 @@ \b[Ll]orem [Ii]psum\b +# +# Overly formal style +# + +# s.b. Whether +\bIndicates whether\b +\bIndicates if\b +\bIndicates\b +\bWhether or not\b +\bDenotes if\b + # # Terms to avoid # # s.b. Allow list -\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 +\b[Ww]hitelist\b +\b[Ww]hitelisting\b +\b[Ww]hitelisted\b +\b[Ww]hite list\b +\b[Ww]hite listing\b +\b[Ww]hite listed\b # s.b. Block list -\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 +\b[Bb]lacklist\b +\b[Bb]lacklisting\b +\b[Bb]lacklisted\b +\b[Bb]lack list\b +\b[Bb]lack listing\b +\b[Bb]lack listed\b # # Our Terms # # s.b. Mondoo Platform -\sthe Mondoo Platform\b -\sMondoo platform\b +\bthe Mondoo Platform\b +\bMondoo platform\b # s.b. Compliance Hub -\s[Cc]ompliance hub\b +\b[Cc]ompliance hub\b # # Compliance Terms @@ -45,6 +56,9 @@ # s.b. SOC 2 \bSOC2\b +# s.b. NIS2 +\bNIS 2\b + # s.b. ISO 270001 \bISO270001\b @@ -64,6 +78,7 @@ # s.b. Docker Hub \bDocker[Hh]ub\b +\bdocker hub\b # s.b. REST API \b[Rr]est API\b @@ -85,6 +100,9 @@ # Product Names # +# s.b. Memcached +\bMemCached\b + # s.b. Jira \bJIRA\b @@ -194,13 +212,25 @@ # s.b. SentinelOne \bSentinal[Oo]ne\b -\bSentinelone\b -\bSentinal One\b +\bSentin[ae]lone\b +\bSentin[ae]l One\b # s.b. CrowdStrike \bCrowd Strike\b \b[Cc]rowdstrike\b +# s.b. Zendesk +\bZenDesk\b + +# s.b. ServiceNow +\bService Now\b +\bServicenow\b + +# disabled due to docs false positives +# s.b. name server +# \bnameserver\b +# \bnameservers\b + # # Kubernetes Terms # @@ -288,6 +318,13 @@ \bLinked In\b \bLinkedin\b +# s.b. Microsoft IIS +\bIIS Server\b + +# s.b. Microsoft SQL Server +\bSQL server\b +\bMSSQL\b + # # VMware Products # @@ -457,7 +494,7 @@ \bWorkmail\b # -# GCP Products +# Google Cloud Products # # s.b. AlloyDB @@ -468,9 +505,11 @@ # s.b. BigLake \bBig Lake\b +\bBiglake\b # s.b. BigQuery \bBig Query\b +\bBigquery\b # s.b. Cloud Build \bCloudBuild\b @@ -529,6 +568,16 @@ \bVMware engine\b \bVMWare Engine\b +# s.b. Bigtable +\bBigTable\b +\bBig Table\b + +# s.b. Datastore +\bDataStore\b + +# s.b. Memorystore +\bMemoryStore\b + # # Azure Products # diff --git a/.github/actions/spelling/reject.txt b/.github/actions/spelling/reject.txt index 2a4063e..1911d16 100644 --- a/.github/actions/spelling/reject.txt +++ b/.github/actions/spelling/reject.txt @@ -14,3 +14,4 @@ Sorce press deets organisation + diff --git a/.github/workflows/cla.yaml b/.github/workflows/cla.yaml index 153d355..4da60ea 100644 --- a/.github/workflows/cla.yaml +++ b/.github/workflows/cla.yaml @@ -1,9 +1,10 @@ +--- name: "CLA Assistant" on: issue_comment: types: [created] pull_request_target: - types: [opened,closed,synchronize] + types: [opened, closed, synchronize] jobs: CLAssistant: @@ -14,13 +15,13 @@ jobs: uses: contributor-assistant/github-action@v2.6.1 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - PERSONAL_ACCESS_TOKEN : ${{ secrets.CLA_ACCESS_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] diff --git a/.github/workflows/spell-check.yaml b/.github/workflows/spell-check.yaml index 22c77fc..ab50934 100644 --- a/.github/workflows/spell-check.yaml +++ b/.github/workflows/spell-check.yaml @@ -23,12 +23,12 @@ jobs: steps: - name: check-spelling id: spelling - uses: check-spelling/check-spelling@v0.0.21 + uses: check-spelling/check-spelling@v0.0.23 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 @@ -47,7 +47,7 @@ jobs: if: (success() || failure()) && needs.spelling.outputs.followup steps: - name: comment - uses: check-spelling/check-spelling@v0.0.21 + uses: check-spelling/check-spelling@v0.0.23 with: checkout: true task: ${{ needs.spelling.outputs.followup }}