fix: ignore draft docs in link checker

Author: notgiorgi

.github/workflows/validate-docs.yml

@@ -34,6 +34,10 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: '18'
+          cache: 'npm'
+
+      - name: Install Node dependencies
+        run: npm ci
 
       - name: Post initial status comment
         id: initial-comment

.gitignore

@@ -6,6 +6,7 @@
 *.iws
 .idea_modules/
 out/
+node_modules/
 images/.DS_Store
 .DS_Store
 .env/

package-lock.json

@@ -0,0 +1,15 @@
+{
+  "name": "mintlify-docs",
+  "version": "1.0.0",
+  "description": "Lightdash documentation",
+  "private": true,
+  "scripts": {},
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lightdash/mintlify-docs.git"
+  },
+  "type": "commonjs",
+  "dependencies": {
+    "gray-matter": "^4.0.3"
+  }
+}

package.json

@@ -8,6 +8,7 @@
 
 const fs = require('fs');
 const path = require('path');
+const matter = require('gray-matter');
 
 const CHECK_EXTERNAL = process.argv.includes('--external');
 
@@ -41,6 +42,11 @@ function findMDXFiles(dir, fileList = []) {
   return fileList;
 }
 
+function hasDraftTitle(content) {
+  const title = matter(content).data.title;
+  return typeof title === 'string' && title.toLowerCase().includes('draft');
+}
+
 function extractLinks(content, filePath) {
   const links = [];
 
@@ -282,9 +288,13 @@ async function main() {
 
   const mdxFiles = findMDXFiles('.');
   const excludedPaths = ['node_modules', '.git', 'CONTRIBUTING.md'];
-  const filteredFiles = mdxFiles.filter(file =>
-    !excludedPaths.some(excluded => file.includes(excluded))
-  );
+  const filteredFiles = mdxFiles.filter(file => {
+    if (excludedPaths.some(excluded => file.includes(excluded))) {
+      return false;
+    }
+
+    return !hasDraftTitle(fs.readFileSync(file, 'utf8'));
+  });
 
   const brokenLinks = [];
   const externalLinks = [];

scripts/check-links.js

@@ -1,5 +1,5 @@
 ---
-title: "Working with timezones in Lightdash"
+title: "Draft: Working with timezones in Lightdash"
 description: "Hidden draft: how to model warehouse data and use Lightdash so that timezones behave predictably."
 hidden: true
 ---