Skip to content
Check spelling

Fremake documentation updates to create_checkout and scripts within gfdlfremake #1229

Sign in to view logs

Fremake documentation updates to create_checkout and scripts within gfdlfremake

Fremake documentation updates to create_checkout and scripts within gfdlfremake #1229

Workflow file for this run

.github/workflows/spell_check.yml at 30549b4
name: 'Check spelling'
on:
pull_request:
branches:
- main
push:
branches:
- main
jobs:
spellcheck:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: streetsidesoftware/cspell-action@v7
continue-on-error: true
with:
# Define glob patterns to filter the files to be checked.
# Use a new line between patterns to define multiple
# patterns. The default is to check ALL files that were
# changed in in the pull_request or push.
# Note: `ignorePaths` defined in cspell.json still apply.
# Example:
# files: |
# **/*.{ts,js}
# !dist/**/*.{ts,js}
#
# Default: ALL files
files: ''
# Check files and directories starting with `.`.
# - "true" - glob searches will match against `.dot` files.
# - "false" - `.dot` files will NOT be checked.
# - "explicit" - glob patterns can match explicit `.dot`
# patterns.
check_dot_files: explicit
# The point in the directory tree to start spell checking.
# Default: .
root: '.'
# Notification level to use with inline reporting of
# spelling errors.
# Allowed values are: warning, error, none
# Default: warning
inline: warning
# Reports flagged / forbidden words as errors.
# If true, errors will still be reported even if `inline`
# is "none"
treat_flagged_words_as_errors: false
# Generate Spelling suggestions.
suggestions: false
# Determines if the action should be failed if any spelling
# issues are found. Allowed values are: true, false
# Default: true
strict: true
# Limit the files checked to the ones in the pull request or
# push.
# This should be changed to true later.
incremental_files_only: false
# Path to `cspell.json`
config: './.cspell.json'
# Log progress and other information during the action
# execution.
# Default: false
verbose: false
# Use the `files` setting found in the CSpell configuration
# instead of `input.files`.
use_cspell_files: false
# Set how unknown words are reported.
# Allowed values are: all, simple, typos, flagged
# Default: all
report: all