Merge pull request #5148 from backstage/timbonicus/docs-quality

Whitelist files for Vale

.github/workflows/docs-quality-checker.yml

@@ -14,5 +14,8 @@ jobs:
       - uses: actions/checkout@v2
       - name: documentation quality check
         uses: errata-ai/vale-action@v1.3.0
+        # Whitelist excluding ADOPTERS, CHANGELOG and OWNERS (no exclude flag exists)
+        with:
+          files: '[".changeset", ".github", "contrib", "docs", "microsite", "packages", "plugins", "CONTRIBUTING.md", "CODE_OF_CONDUCT.md", "GOVERNANCE.md", "README.md"]'
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

scripts/check-docs-quality.js

@@ -40,6 +40,7 @@ const getFilesToLint = () => {
     command = `git ls-files | .\\node_modules\\.bin\\shx grep ".md"`;
   }
 
+  // Note this ignore list only applies locally, CI runs `.github/workflows/docs-quality-checker.yml`
   const ignored = ['', 'ADOPTERS.md', 'OWNERS.md'];
   return execSync(command, {
     stdio: ['ignore', 'pipe', 'inherit'],