Skip to main content

Spellcheck component

The spellcheck component checks Markdown files with Vale. It reports suggestions in the job log and fails when Vale finds an error-level spelling problem.

The job runs when the repository contains at least one Markdown file. Scheduled pipelines skip the job. By default, findings are allowed to fail so teams can introduce the component without blocking an existing pipeline.

Usage​

Add the common component before the spellcheck component in .gitlab-ci.yml:

include:
  - component: $CI_SERVER_FQDN/xrow-public/ci-tools/common@stable
  - component: $CI_SERVER_FQDN/xrow-public/ci-tools/spellcheck@stable

The job uses the lint stage by default. Set stage when the pipeline uses a different stage name:

include:
  - component: $CI_SERVER_FQDN/xrow-public/ci-tools/common@stable
  - component: $CI_SERVER_FQDN/xrow-public/ci-tools/spellcheck@stable
    inputs:
      stage: test

Use the needs input to make the spellcheck job wait for other jobs:

include:
  - component: $CI_SERVER_FQDN/xrow-public/ci-tools/common@stable
  - component: $CI_SERVER_FQDN/xrow-public/ci-tools/spellcheck@stable
    inputs:
      needs:
        - job: generate-documentation

Inputs​

NameDescriptionDefaultType
------------
needsThe jobs that this job depends on.[]array
stagelintstring