-
Notifications
You must be signed in to change notification settings - Fork 607
Try spell linter #3263
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
Closed
Closed
Try spell linter #3263
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| # cSpell:ignore textlintrc | ||
| # For settings, see | ||
| # https://www.streetsidesoftware.com/vscode-spell-checker/docs/configuration/ | ||
| version: '0.2' | ||
| caseSensitive: false | ||
| patterns: | ||
| - name: CodeBlock | ||
| pattern: | | ||
| / | ||
| ^(\s*[~`]{3,}) # code-block start | ||
| .* # all languages and options, e.g. shell {hl_lines=[12]} | ||
| [\s\S]*? # content | ||
| \1 # code-block end | ||
| /igmx | ||
| languageSettings: | ||
| - languageId: markdown | ||
| ignoreRegExpList: | ||
| - CodeBlock | ||
| words: | ||
| - AWSX | ||
| - Azuma | ||
| - backports | ||
| - behaviour | ||
| - callables | ||
| - circleci | ||
| - Clientcontext | ||
| - codeowners | ||
| - dalli | ||
| - datadog | ||
| - enqueuers | ||
| - ethon | ||
| - excon | ||
| - faas | ||
| - fanout | ||
| - faraday | ||
| - gettime | ||
| - gemfile | ||
| - gruf | ||
| - HTTPX | ||
| - httpx | ||
| - instrumenter | ||
| - linux | ||
| - lmdb | ||
| - microbenchmarks | ||
| - myapp | ||
| - namespacing | ||
| - opentelemetry | ||
| - otelcol | ||
| - ottrace | ||
| - postgres | ||
| - postgresql | ||
| - racecar | ||
| - rabbitmq | ||
| - Railtie | ||
| - Rakefile | ||
| - rdkafka | ||
| - resque | ||
| - restclient | ||
| - rubocop | ||
| - rubydocs | ||
| - ruboproof | ||
| - rubygems | ||
| - semconv | ||
| - sidekiq | ||
| - sinatra | ||
| - spanid | ||
| - toolset | ||
| - traceid | ||
| - traceresponse | ||
| - Untrace | ||
| - vitess | ||
| - webmocks | ||
| - yardoc | ||
| - traceparent |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| name: Check Spelling | ||
|
|
||
| on: | ||
| pull_request: | ||
|
|
||
| jobs: | ||
| spelling-check: | ||
| name: SPELLING check | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: streetsidesoftware/cspell-action@v6 | ||
| with: | ||
| # Files should be consistent with check:spelling files | ||
| files: | | ||
| **/*.md | ||
| config: .cspell.yml | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Check warning
Code scanning / CodeQL
Workflow does not contain permissions Medium
Copilot Autofix
AI 5 months ago
The best way to fix this issue is to explicitly specify the permissions required by the workflow or job. In this case, the job is only checking out code and running a spelling check on markdown files, so only minimal permissions are needed—specifically, read access to repository contents. No write access is required. The permissions block can be placed either at the top/root of the workflow (to apply to all jobs) or at the job level. Since there is a single job in this workflow, either placement is fine; placing it at the root is conventional and applies strict defaults if other jobs are ever added.
To fix:
permissions:block immediately after the workflowname:, with at minimumcontents: read.