Skip to content
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

Switch to pkg.dev #3

Closed
wants to merge 6 commits into from
Closed

Switch to pkg.dev #3

wants to merge 6 commits into from

Conversation

jsoref
Copy link
Contributor

@jsoref jsoref commented Mar 10, 2025

No description provided.

@jsoref jsoref requested a review from drozd-A March 10, 2025 19:41
Copy link

@check-spelling-bot Report

🔴 Please review

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

Unrecognized words (28)
allowlist
api
apps
args
Artifactory
Autogenerated
AWS
chmod
config
filetype
fullname
gserviceaccount
hostname
iam
json
metadata
mkdir
noreply
Npm
OAuth
plugins
printf
regex
Softlayer
templated
uuid
workflow
yaml
These words are not needed and should be removed serviceaccount

Some files were automatically ignored 🙈

These sample patterns would exclude them:

^\Q.github/actions/secret-scanner/excluded_files.patterns\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, update file exclusions, and remove the previously acknowledged and now absent words, you could run the following commands

... in a clone of the [email protected]:GarnerCorp/ssh-gateway-helm.git repository
on the pkg.dev branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/prerelease/apply.pl' |
perl - 'https://github.com/GarnerCorp/ssh-gateway-helm/actions/runs/13773364391/attempts/1'

OR

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

Available 📚 dictionaries could cover words (expected and unrecognized) not in the 📘 dictionary

This includes both expected items (18) from .github/actions/spelling/expect.txt and unrecognized words (28)

Dictionary Entries Covers Uniquely
cspell:software-terms/dict/softwareTerms.txt 1288 15 1
cspell:php/dict/php.txt 1689 13
cspell:node/dict/node.txt 891 11
cspell:k8s/dict/k8s.txt 153 10 1
cspell:aws/aws.txt 218 10 1

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

      with:
        extra_dictionaries: |
          cspell:software-terms/dict/softwareTerms.txt
          cspell:php/dict/php.txt
          cspell:node/dict/node.txt
          cspell:k8s/dict/k8s.txt
          cspell:aws/aws.txt

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

check_extra_dictionaries: ""
Pattern suggestions ✂️ (1)

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

# Automatically suggested patterns

# hit-count: 1 file-count: 1
# Markdown anchor links
\(#\S*?[a-zA-Z]\S*?\)

Warnings (2)

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

⚠️ Warnings Count
ℹ️ candidate-pattern 1
⚠️ noisy-file 1

See ⚠️ Event descriptions for more information.

If the flagged items are 🤯 false positives

If items relate to a ...

  • binary file (or some other file you wouldn't want to check at all).

    Please add a file path to the excludes.txt file matching the containing file.

    File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

    ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

  • well-formed pattern.

    If you can write a pattern that would match it,
    try adding it to the patterns.txt file.

    Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

    Note that patterns can't match multiline strings.

@jsoref jsoref closed this Mar 10, 2025
@jsoref jsoref deleted the pkg.dev branch March 10, 2025 19:44
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