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.
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:
projectFiles:
name: Project File Quality
uses: brobeson/SupportFileQuality/.github/workflows/support_files.yaml@v1The workflow runs the following steps.
- Spell Check
The workflow runs CSpell on all files in the repository. 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. - Markdown Lint
The workflow also runs Markdownlint on all Markdown files in the repository. It uses markdownlint-cli2, so you can configure it. - Prettier
Finally, the workflow runs Prettier to check formatting of any files in the repository. It does not format and commit changes; it reports files that are incorrectly formatted.
