Support File Quality

This is a reusable workflow to ensure quality in project support files and tool configuration files (dot files). For general help with reusable workflows, check out GitHub's Reusing workflows documentation.

Getting Started

To use this workflow, just set it in the uses key of a job in your project's workflow file. Here is an example workflow snippet that calls this workflow:

jobs:
  dotFiles:
    name: Dot File Quality
    uses: brobeson/SupportFileQuality/.github/workflows/support_files.yaml@v1

Steps

The workflow runs the steps described in the following sections.

1. Spell Check
   The workflow runs CSpell on all files in the repository except your .git/ directory. Use a CSpell configuration in your repository to control the spell check behavior. You can add CSpell to your IDE to reduce the probability of this step finding errors. If you use VS Code, you can use the Code Spell Checker extension.
2. Markdown Lint
   The workflow also runs Markdownlint on all Markdown files in the repository.

Issue Tracking

Report a bug | Request a new step | Update an existing step