action.yml

name: 'Check Spelling'
description: 'Spell check code and commits'
author: 'jsoref'
branding:
  icon: 'edit-3'
  color: 'red'
inputs:
  GITHUB_TOKEN:
    description: 'The GITHUB_TOKEN secret'
    default: "${{ github.token }}"
    required: true
  bucket:
    description: 'Container for spelling configuration'
    required: false
  project:
    description: 'Folder/Branch within bucket containing spelling configuration'
    required: false
  config:
    description: 'Spelling configuration directory'
    default: ".github/actions/spelling"
    required: false
  experimental_path:
    description: 'Directory root to check for spelling (note that bucket/project/config are independent of this)'
    default: '.'
    required: false
  dictionary_url:
    description: "Location of dictionary (if you aren't providing one in your repository)"
    default: 'https://raw.githubusercontent.com/check-spelling/check-spelling/dictionary-$DICTIONARY_VERSION/dict.txt'
    required: false
  dictionary_version:
    description: 'Version of the dictionary (only used if the url includes $DICTIONARY_VERSION)'
    default: "20200211"
    required: false
  debug:
    description: 'Debug'
    required: false
  experimental_apply_changes_via_bot:
    description: '(Experimental) Allow users to quote-reply to the bot comment to update the PR'
    default: "0"
    required: false
  experimental_parallel_jobs:
    description: 'Number of CPUs available for running checks'
    required: false
    default: '2'
  post_comment:
    description: 'Post comment with report'
    required: false
    default: '1'
  capture_output_unknown_words:
    description: ''
    required: false
    deprecationMessage: 'Obsolete: outputs are always captured'
    default: ''
  capture_output_stale_words:
    description: ''
    deprecationMessage: 'Obsolete: outputs are always captured'
    required: false
    default: ''
  capture_output_skipped_files:
    description: ''
    deprecationMessage: 'Obsolete: outputs are always captured'
    required: false
    default: ''
  dictionary_source_prefixes:
    description: 'JSON map of prefixes for dictionary urls'
    required: false
    default: '{"cspell": "https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/"}'
  extra_dictionaries:
    description: 'Space delimited list of URLs (or `prefix:`+path) to additional word lists'
    required: false
    default: ''
  check_extra_dictionaries:
    description: 'Compare unknown tokens against these dictionaries and suggest if applicable'
    required: false
    default:
      cspell:ada/dict/ada.txt
      cspell:aws/aws.txt
      cspell:clojure/src/clojure.txt
      cspell:companies/src/companies.txt
      cspell:cpp/src/compiler-clang-attributes.txt
      cspell:cpp/src/compiler-gcc.txt
      cspell:cpp/src/compiler-msvc.txt
      cspell:cpp/src/ecosystem.txt
      cspell:cpp/src/lang-jargon.txt
      cspell:cpp/src/lang-keywords.txt
      cspell:cpp/src/people.txt
      cspell:cpp/src/stdlib-c.txt
      cspell:cpp/src/stdlib-cerrno.txt
      cspell:cpp/src/stdlib-cmath.txt
      cspell:cpp/src/stdlib-cpp.txt
      cspell:cpp/src/template-strings.txt
      cspell:cryptocurrencies/cryptocurrencies.txt
      cspell:csharp/csharp.txt
      cspell:css/dict/css.txt
      cspell:dart/src/dart.txt
      cspell:django/dict/django.txt
      cspell:django/requirements.txt
      cspell:docker/src/docker-words.txt
      cspell:dotnet/dict/dotnet.txt
      cspell:elixir/dict/elixir.txt
      cspell:filetypes/filetypes.txt
      cspell:fonts/fonts.txt
      cspell:fullstack/dict/fullstack.txt
      cspell:gaming-terms/dict/gaming-terms.txt
      cspell:golang/dict/go.txt
      cspell:haskell/dict/haskell.txt
      cspell:html-symbol-entities/entities.txt
      cspell:html/dict/html.txt
      cspell:html/src/svg.txt
      cspell:java/src/java-terms.txt
      cspell:java/src/java.txt
      cspell:k8s/dict/k8s.txt
      cspell:latex/dict/latex.txt
      cspell:latex/samples/sample-words.txt
      cspell:lisp/lisp.txt
      cspell:lorem-ipsum/dictionary.txt
      cspell:lua/dict/lua.txt
      cspell:mnemonics/src/mnemonics.txt
      cspell:monkeyc/src/monkeyc_keywords.txt
      cspell:node/dict/node.txt
      cspell:npm/dict/npm.txt
      cspell:php/dict/php.txt
      cspell:powershell/dict/powershell.txt
      cspell:public-licenses/src/additional-licenses.txt
      cspell:public-licenses/src/generated/public-licenses.txt
      cspell:python/src/additional_words.txt
      cspell:python/src/common/extra.txt
      cspell:python/src/python/python-lib.txt
      cspell:python/src/python/python.txt
      cspell:r/src/r.txt
      cspell:redis/dict/redis.txt
      cspell:ruby/dict/ruby.txt
      cspell:rust/dict/rust.txt
      cspell:scala/dict/scala.txt
      cspell:shell/dict/shell-all-words.txt
      cspell:software-terms/dict/softwareTerms.txt
      cspell:software-terms/dict/webServices.txt
      cspell:sql/src/sql.txt
      cspell:sql/src/tsql.txt
      cspell:svelte/dict/svelte.txt
      cspell:swift/src/swift.txt
      cspell:typescript/dict/typescript.txt
  extra_dictionary_limit:
    description: 'Limit the number of suggested extra dictionaries.'
    required: false
    default: '5'
  event_aliases:
    description: >-
      Try to treat a GitHub event "a" as GitHub event "b" (JSON map).
      If this flag was available before this tool recognized `pull_request_target`,
      `{"pull_request_target":"pull_request"}` would have mapped it to `pull_request`.
    required: false
    default: ''
  shortest_word:
    description: 'Shortest word'
    required: false
    default: '3'
  longest_word:
    description: 'Longest word'
    required: false
    default: ''
  experimental_commit_note:
    description: 'If set, commit updates to expect automatically with this note'
    required: false
    default: ''
  suppress_push_for_open_pull_request:
    description: "If set, do not do work in response to `push` if there is an open `pull` request to the repository for the branch (this assumes there's a `pull_request_target` event configured)."
    required: false
    default: ''
  report_title_suffix:
    description: 'Suffix for report title (useful if you are using a matrix strategy or are using experimental_path)'
    required: false
    default: ''
  only_check_changed_files:
    description: 'If set, only check files changed since the last push'
    required: false
    default: ''
  custom_task:
    description: 'Run an internal task instead of responding to a GitHub event. Values: "comment"'
    # This will be superseded by task
    required: false
    default: ''
  internal_state_directory:
    description: 'Used for passing internal state from the (default) check mode to the comment module'
    required: false
    default: ''
  check_file_names:
    description: 'Spell check file paths'
    required: false
    default: ''
  check_commit_messages:
    description: 'List of extra text to check (latest `commit` message, messages for pending `commits`, PR `title`, PR `description`)'
    required: false
    default: ''
  anonymize_secpoll_source:
    description: 'Perform secpoll queries via a public dns server'
    required: false
    default: ''
  ignore_security_advisory:
    description: 'Set to the value of the current security advisory to accept the reported risk -- value must match -- do not set if there is no current advisory'
    required: false
    default: ''
  largest_file:
    description: 'File size limit'
    required: false
    default: '1048576'
  unknown_word_limit:
    description: 'Only report an unknown word this many times'
    required: false
    default: '5'
  warnings:
    description: 'List of events that are warnings (items that are neither warnings nor notices will result in an :x:)'
    required: false
    default: bad-regex,binary-file,deprecated-feature,large-file,limited-references,no-newline-at-eof,noisy-file,non-alpha-in-dictionary,token-is-substring,unexpected-line-ending,whitespace-in-dictionary,minified-file,unsupported-configuration
  notices:
    description: 'List of events that are notices (items that are neither warnings nor notices will result in an :x:)'
    required: false
    default: candidate-pattern
  quit_without_error:
    description: 'Suppress failure code exit code -- it will be available via outputs.result_code'
    required: false
    default: ''
  spell_check_this:
    description: 'Repository with default configuration to use if no configuration is found in a .github/actions/spelling directory'
    required: false
    default: ''
  ssh_key:
    description: 'Key for checking out / pushing to updates (and trigger workflow cascades)'
    required: false
    default: ''
  checkout:
    description: 'Whether to check out a repository'
    required: false
    default: ''
  task:
    description: 'Task to perform (spelling, comment, ...)'
    required: false
    default: ''
  disable_checks:
    description: 'Some heuristics might not do what you want, it may be possible to suppress them'
    required: false
    default: ''
  alternate_engine:
    description: 'Alternate engine to use'
    required: false
    default: ''
  alternate_engine_key:
    description: 'ssh key to retrieve alternate engine'
    required: false
    default: ''
  use_sarif:
    description: 'Publish Sarif report'
    required: false
    default: ''
  use_magic_file:
    description: 'Use magic file to skip binary files'
    required: false
    default: ''
  caller_container:
    description: "Hack for nektos/act - pass the outputs.docker_container to give check-spelling a way to retrieve data it needs to report a comment"
    required: false
  candidate_example_limit:
    description: 'Control the number of examples shown for candidate patterns'
    required: false
    default: 3
  summary_table:
    description: 'Provide item table (paths, content)'
    required: false
    default: 1
  ignore-pattern:
    description: 'Word Splitter Ignore Pattern'
    required: false
    default: "[^a-zA-Z']"
  upper-pattern:
    description: 'Word Splitter Upper Pattern'
    required: false
    default: "[A-Z]"
  lower-pattern:
    description: 'Word Splitter Lower Pattern'
    required: false
    default: "[a-z]"
  not-lower-pattern:
    description: 'Word Splitter Not Lower Pattern'
    required: false
    default: "[^a-z]"
  not-upper-or-lower-pattern:
    description: 'Word Splitter Not Upper or Lower Pattern'
    required: false
    default: "[^A-Za-z]"
  punctuation-pattern:
    description: 'Word Splitter Punctuation Pattern'
    required: false
    default: "'"
  report-timing:
    description: 'Report processing time for files'
    required: false
    default: ''
  cache-dictionaries:
    description: 'Cache dictionaries'
    required: false
    default: 1

outputs:
  unknown_words:
    description: "Unrecognized words (should be added to expect.txt)"
    value: ${{ steps.spelling.outputs.unknown_words }}
  stale_words:
    description: "Stale words (should be removed from expect.txt) as an output"
    value: ${{ steps.spelling.outputs.stale_words }}
  skipped_files:
    description: "Skipped files (could be added to excludes.txt)"
    value: ${{ steps.spelling.outputs.skipped_files }}
  suggested_dictionaries:
    description: "Suggested dictionaries (could be added to extra_dictionaries)"
    value: ${{ steps.spelling.outputs.suggested_dictionaries }}
  warnings:
    description: "Warnings"
    value: ${{ steps.spelling.outputs.warnings }}
  internal_state_directory:
    description: 'Used for passing internal state from the (default) check mode to the comment module'
    value: ${{ steps.spelling.outputs.internal_state_directory }}
  result_code:
    description: "Result (indicates unrecognized words were found or comment needs to be collapsed)"
    value: ${{ steps.spelling.outputs.result_code }}
  followup:
    description: "Next task"
    value: ${{ steps.spelling.outputs.followup }}
  docker_container:
    description: "Hack for nektos/act - pass to inputs.caller_container to give check-spelling a way to retrieve data it needs to report a comment"
    value: ${{ steps.spelling.outputs.docker_container }}

runs:
  using: 'composite'
  steps:
    - name: act-broken
      if: env.ACT && (github.action_path || env.GITHUB_ACTION_PATH) && (env.GITHUB_ACTION_PATH != github.action_path)
      shell: bash
      run: |
        echo '::error ::This version of nektos/act is broken. See https://github.com/check-spelling/check-spelling/wiki/Breaking-Change:-Dropping-support-for-broken-act'
        exit 1
    - name: act-windows-shim
      if: env.ACT
      shell: bash
      run: |
        THIS_ACTION_PATH=$(realpath "$GITHUB_ACTION_PATH")
        chmod +x $THIS_ACTION_PATH/*.sh $THIS_ACTION_PATH/*.pl $THIS_ACTION_PATH/wrappers/*
        perl -pi -e's/\015\012/\012/g' $THIS_ACTION_PATH/*.sh $THIS_ACTION_PATH/*.pl $THIS_ACTION_PATH/wrappers/*
    - name: parse alternate engine
      id: parse-alternate-engine
      if: inputs.alternate_engine
      shell: bash
      run: |
        echo "repo=$(echo '${{ inputs.alternate_engine }}' | perl -pe 's/\@.*//')" >> "$GITHUB_OUTPUT"
        echo "branch=$(echo '${{ inputs.alternate_engine }}' | perl -ne 'next unless s/.*\@//; print')" >> "$GITHUB_OUTPUT"
    - name: alternate-engine
      if: inputs.alternate_engine
      uses: actions/checkout@v4
      with:
        path: alternate-engine
        repository: ${{ steps.parse-alternate-engine.outputs.repo }}
        ref: ${{ steps.parse-alternate-engine.outputs.branch }}
        ssh-key: ${{ inputs.alternate_engine_key }}
        persist-credentials: false
    - name: install-alternate-engine
      if: inputs.alternate_engine
      shell: bash
      run: |
        rsync --delete --exclude=.git -a alternate-engine/ "$GITHUB_ACTION_PATH"/
        rm -rf alternate-engine/
    - name: shim-path
      shell: bash
      run: |
        THIS_ACTION_PATH=$(realpath "$GITHUB_ACTION_PATH")
        echo "THIS_ACTION_PATH=$THIS_ACTION_PATH" >> "$GITHUB_ENV"
        echo "PATH=$THIS_ACTION_PATH/wrappers:$PATH" >> "$GITHUB_ENV"
    - name: check-actions
      id: check-actions
      env:
        spellchecker: ${{ env.THIS_ACTION_PATH }}
        GH_ACTION_REPOSITORY: ${{ github.action_repository || github.repository }}
        GH_ACTION_REF: ${{ github.action_ref || github.ref_name }}
      run: |
        secpoll
      shell: bash
    - name: checkout
      id: checkout-replacement
      if: inputs.checkout && inputs.checkout != 'false' && !inputs.custom_task && env.replace_v3_actions_checkout
      uses: check-spelling/actions-checkout@v4
      with:
        path: ${{ inputs.experimental_path }}
        ssh-key: ${{ inputs.ssh_key }}
        fetch-depth: ${{ !contains(inputs.check_commit_messages, 'commits') && '1' || '0' }}
        token: ${{ inputs.GITHUB_TOKEN }}
        ref: |
          ${{
            github.event_name == 'issue_comment' &&
            github.event.issue.pull_request &&
            github.event.pull_request.head.sha ||
            ''
          }}
    - name: checkout
      if: inputs.checkout && inputs.checkout != 'false' && !inputs.custom_task && !env.replace_v4_actions_checkout
      uses: actions/checkout@v4
      with:
        path: ${{ inputs.experimental_path }}
        ssh-key: ${{ inputs.ssh_key }}
        fetch-depth: ${{ !contains(inputs.check_commit_messages, 'commits') && '1' || '0' }}
        token: ${{ inputs.GITHUB_TOKEN }}
        ref: |
          ${{
            github.event_name == 'issue_comment' &&
            github.event.issue.pull_request &&
            github.event.pull_request.head.sha ||
            ''
          }}
    - name: checkout-merge
      id: checkout-merge
      if: github.event.pull_request.number && (contains(github.event_name, 'pull_request')) && (inputs.checkout && inputs.checkout != 'false' && !inputs.custom_task && !inputs.task)
      uses: check-spelling/checkout-merge@v0.0.4
      with:
        path: ${{ inputs.experimental_path }}
    - name: raise-merge-failure
      if: steps.checkout-merge.outputs.message
      env:
        MESSAGE: ${{ steps.checkout-merge.outputs.message }}
      shell: bash
      run: |
        echo ::error "::$MESSAGE"
    - name: save sha
      if: (contains(github.event_name, 'pull_request')) && (inputs.checkout && inputs.checkout != 'false' && !inputs.custom_task && !inputs.task) && inputs.use_sarif
      shell: bash
      run: |
        cd "${{ inputs.experimental_path }}"
        git show HEAD
        PRIVATE_SARIF_REF="refs/pull/${{ github.event.pull_request.number }}/merge"
        echo "PRIVATE_SARIF_REF=$PRIVATE_SARIF_REF" >> "$GITHUB_ENV"
        git fetch origin "$PRIVATE_SARIF_REF"
        echo "PRIVATE_SARIF_SHA=$(git rev-parse FETCH_HEAD)" >> "$GITHUB_ENV"
    - name: prepare
      if: inputs.task && inputs.task != 'spelling' && (!env.ACT || github.token)
      run: |
        mkdir -p /tmp/data;
        echo "INPUT_INTERNAL_STATE_DIRECTORY=/tmp/data" >> "$GITHUB_ENV"
      shell: bash
    - name: retrieve-comment
      if: inputs.task && inputs.task != 'spelling' && (!env.ACT || github.token)
      uses: actions/download-artifact@v4
      with:
        name: "check-spelling-comment"
        path: /tmp/data
    - name: hash-dictionaries
      id: hash-dictionaries
      if: ${{ !inputs.task || inputs.task == 'spelling' }}
      env:
        INPUT_TASK: hash-dictionaries
        INPUT_DICTIONARY_SOURCE_PREFIXES: ${{ inputs.dictionary_source_prefixes || inputs.dictionary-source-prefixes }}
        INPUT_EXTRA_DICTIONARIES: ${{ inputs.extra_dictionaries || inputs.extra-dictionaries }} ${{ inputs.check_extra_dictionaries || inputs.check-extra-dictionaries }}
        INPUT_USE_SARIF: ${{ inputs.use_sarif || inputs.use-sarif }}
      shell: bash
      run: |
        unknown-words
    - name: retrieve-dictionaries
      id: retrieve-dictionaries
      if: ${{ env.DICTIONARY_URLS_HASH }}
      uses: actions/cache/restore@v4
      with:
        path: ${{ env.THIS_ACTION_PATH }}/dictionaries
        key: check-spelling-dictionaries-${{ env.DICTIONARY_URLS_HASH }}-${{ github.sha}}
        restore-keys: check-spelling-dictionaries-${{ env.DICTIONARY_URLS_HASH }}
    - name: perl configuration
      id: perl-config
      if: steps.hash-dictionaries.outputs.perl-libraries
      shell: bash
      run: |
        perl_modules="$(
          echo "${{ steps.hash-dictionaries.outputs.perl-libraries }}" |tr " " "\n" |sort|xargs)"
        perl_modules_sha=$(echo "$perl_modules" | shasum | perl -pe 's/\s.*//')
        installsitearch=$(perl -V:'installsitearch' | perl -pe 's/.*=.(.*).;/$1/')
        installsitelib=$(perl -V:'installsitelib' | perl -pe 's/.*=.(.*).;/$1/')
        sudo install -d -o $(whoami) "$installsitearch" "$installsitelib"
        (
          echo "installsitearch=$installsitearch"
          echo "installsitelib=$installsitelib"
          echo "perl-modules=$perl_modules"
          echo "perl-key=check-spelling-perl-$(perl -e 'print "$^V"')-$perl_modules_sha"
        ) >> "$GITHUB_OUTPUT"
    - name: retrieve perl libraries arch
      id: retrieve-perl-libraries-arch
      if: steps.perl-config.outputs.installsitearch
      uses: actions/cache/restore@v4
      with:
        path: ${{ steps.perl-config.outputs.installsitearch }}
        key: ${{ steps.perl-config.outputs.perl-key }}-arch
    - name: retrieve perl libraries lib
      id: retrieve-perl-libraries-lib
      if: steps.perl-config.outputs.installsitelib
      uses: actions/cache/restore@v4
      with:
        path: ${{ steps.perl-config.outputs.installsitelib }}
        key: ${{ steps.perl-config.outputs.perl-key }}-lib

    - name: install perl modules
      if: steps.perl-config.outputs.perl-modules
      shell: bash
      run: |
        cpan_modules=$(
          for module in ${{ steps.perl-config.outputs.perl-modules }}; do
            perl -e "use $module; 1;" > /dev/null 2>/dev/null || echo $module
          done | xargs
        )
        if [ -n "$cpan_modules" ]; then
          command -v cpanm >/dev/null 2>/dev/null || curl -s -S -L https://cpanmin.us | perl - --sudo App::cpanminus
          perl `command -v cpanm` -S --notest $cpan_modules
        fi
    - name: check-spelling
      id: spelling
      if: env.MERGE_FAILED != '1'
      env:
        INPUTS: ${{ toJSON(inputs) }}
        DEBUG: ${{ inputs.debug }}
        spellchecker: ${{ env.THIS_ACTION_PATH }}
        GH_ACTION_REPOSITORY: ${{ github.action_repository || github.repository }}
        GH_ACTION_REF: ${{ github.action_ref || github.ref_name }}
      run:
        unknown-words
      shell: bash
    - name: save-dictionaries
      uses: actions/cache/save@v4
      if: (success() || failure()) && steps.spelling.outputs.CACHE_DICTIONARIES == '1'
      with:
        path: ${{ env.THIS_ACTION_PATH }}/dictionaries
        key: check-spelling-dictionaries-${{ env.DICTIONARY_URLS_HASH }}-${{ github.sha}}
    - name: save perl libraries arch
      if: ${{ (success() || (failure() && env.MERGE_FAILED != '1')) && steps.retrieve-perl-libraries-arch.outputs.cache-hit != 'true' && steps.perl-config.outputs.installsitearch }}
      id: save-perl-libraries-arch
      uses: actions/cache/save@v4
      with:
        path: ${{ steps.perl-config.outputs.installsitearch }}
        key: ${{ steps.perl-config.outputs.perl-key }}-arch
    - name: save perl libraries lib
      if: ${{ (success() || (failure() && env.MERGE_FAILED != '1')) && steps.retrieve-perl-libraries-lib.outputs.cache-hit != 'true' && steps.perl-config.outputs.installsitelib }}
      id: save-perl-libraries-lib
      uses: actions/cache/save@v4
      with:
        path: ${{ steps.perl-config.outputs.installsitelib }}
        key: ${{ steps.perl-config.outputs.perl-key }}-lib
    - name: store-comment
      if: (contains(github.event_name, 'pull_request') ||
          github.event_name == 'push') &&
        inputs.custom_task != 'comment' &&
        ((failure() && env.MERGE_FAILED != '1') || steps.spelling.outputs.followup) &&
        steps.spelling.outputs.internal_state_directory
      uses: actions/upload-artifact@v4
      with:
        name: "check-spelling-comment"
        path: |
          ${{ steps.spelling.outputs.internal_state_directory }}
    - name: Shim Sarif
      id: shim-sarif
      if: (success() || (failure() && env.MERGE_FAILED != '1')) && env.UPLOAD_SARIF != '' && env.PRIVATE_SARIF_SHA != ''
      shell: bash
      run: |
        cd "${{ inputs.experimental_path }}"
        git reset "$PRIVATE_SARIF_SHA"
    - name: artifact-sarif
      id: artifact-sarif
      if: (success() || (failure() && env.MERGE_FAILED != '1')) && env.UPLOAD_SARIF != ''
      uses: actions/upload-artifact@v4
      with:
        name: "check-spelling-sarif"
        retention-days: 1
        path: |
          ${{ env.UPLOAD_SARIF }}
    - name: upload-sarif
      id: upload-sarif
      if: (success() || (failure() && env.MERGE_FAILED != '1')) && env.UPLOAD_SARIF != ''
      uses: github/codeql-action/upload-sarif@v2
      with:
        wait-for-processing: false
        sarif_file: ${{ env.UPLOAD_SARIF }}
        category: ${{ inputs.report_title_suffix && format('{0}-{1}', 'check-spelling', inputs.report_title_suffix) || 'check-spelling' }}
        checkout_path: ${{ inputs.experimental_path }}
        ref: ${{ env.PRIVATE_SARIF_REF }}
        sha: ${{ env.PRIVATE_SARIF_SHA }}