View on GitHub

check-spelling-docs

Documentation for check-spelling

Code Scanning action requires a Code Scanning Ruleset

As of check-spelling v0.0.25, if you enable SARIF output, then check-spelling will not yield an :x: for errors. If you are relying on status checks, you'll need to add a code-scanning rule instead. The following is an example of a code-scanning rule which should work:

Sample ruleset

{
  "name": "check-spelling",
  "target": "branch",
  "source_type": "Repository",
  "enforcement": "active",
  "conditions": {
    "ref_name": {
      "exclude": [],
      "include": [
        "~DEFAULT_BRANCH",
        "refs/heads/master",
        "refs/heads/main"
      ]
    }
  },
  "rules": [
    {
      "type": "deletion"
    },
    {
      "type": "non_fast_forward"
    },
    {
      "type": "required_linear_history"
    },
    {
      "type": "code_scanning",
      "parameters": {
        "code_scanning_tools": [
          {
            "tool": "check-spelling",
            "security_alerts_threshold": "high_or_higher",
            "alerts_threshold": "errors"
          }
        ]
      }
    }
  ],
  "bypass_actors": []
}

Information about Rulesets

For more information on Rulesets, see Creating rulesets for a repository.