Global antora file

.github/workflows/validate.yml

@@ -17,7 +17,18 @@ jobs:
     - uses: actions/setup-node@v4
       with:
         node-version: 16
+
+    - name: Checkout global antora-playbook
+      uses: actions/checkout@v4
+      with:
+        repository: hazelcast/hazelcast-docs
+        sparse-checkout: antora-playbook.yml
+        sparse-checkout-cone-mode: false
+        path: hazelcast-docs
+        ref: main
+
     - name: Check for broken internal links
       run: |
         npm i
+        npm run-script fetch-check-links-playbook -- $GITHUB_REPOSITORY $GITHUB_BASE_REF
         npm run-script check-links-local

load-check-links-playbook.js

@@ -0,0 +1,48 @@
+const YAML = require('yaml');
+const fs = require('fs');
+
+const [currentRepoName, baseBranchName] = process.argv.slice(-2);
+
+if (currentRepoName.endsWith('.js') || baseBranchName.endsWith('.js')) {
+	throw new Error('GitHub repository name and base branch should be passed as arguments');
+}
+
+console.log('Repository name: ', currentRepoName);
+console.log('Base branch: ', baseBranchName);
+
+// 1. Load and parse local antora-playbook.yml
+const localAntoraPlaybookContent = fs.readFileSync('./antora-playbook.yml', 'utf8');
+const localAntoraPlaybook = YAML.parse(localAntoraPlaybookContent);
+
+// 2. Load and parse global antora-playbook.yml's content.sources
+const globalAntoraPlaybookContent = fs.readFileSync('./hazelcast-docs/antora-playbook.yml', 'utf8');
+const globalAntoraPlaybook = YAML.parse(globalAntoraPlaybookContent);
+let globalSources = globalAntoraPlaybook.content.sources;
+// 3. Modify global content.sources
+// 		- add hazelcast-docs GitHub URL
+const hazelcastDocsSource = globalSources.find(source => source.url === '.');
+hazelcastDocsSource.url = 'https://github.com/hazelcast/hazelcast-docs';
+
+// 		- remove Swagger docs
+globalSources = globalSources.filter(source =>
+	!(source.url === 'https://github.com/hazelcast/hazelcast-mono')
+	&& !(source.url === 'https://github.com/hazelcast/management-center'));
+
+// 		- add current branch
+globalSources.unshift({
+	url: '.',
+	branches: 'HEAD',
+	start_path: 'docs',
+});
+
+// 		- remove current branch from the
+const currentRepoSource = globalSources.find(source => source.url.endsWith(currentRepoName));
+currentRepoSource.branches.push(`!${baseBranchName}`);
+
+localAntoraPlaybook.content.sources = globalSources;
+// 4. Replace local content.sources with the modified content.sources
+fs.writeFileSync(
+	'./check-links-playbook.yml',
+	YAML.stringify(localAntoraPlaybook),
+	{ encoding: 'utf8' },
+);

package.json

@@ -7,17 +7,19 @@
   "scripts": {
     "build": "antora --to-dir docs --fetch antora-playbook.yml",
     "build-local": "antora --to-dir test --fetch antora-playbook-local.yml",
+    "fetch-check-links-playbook": "node load-check-links-playbook.js",
     "check-links-local": "antora --fetch --to-dir test --log-level=error --log-failure-level=error --extension=@jcahills/antora-link-checker check-links-playbook.yml",
     "serve": "serve test",
     "expose": "ngrok http 5000"
   },
   "devDependencies": {
     "@antora/cli": "^3.1.1",
     "@antora/site-generator": "^3.1.1",
-    "@jcahills/antora-link-checker": "^1.0.1",
     "@djencks/antora-aggregate-collector": "^0.1.0-beta.1",
+    "@jcahills/antora-link-checker": "^1.0.1",
     "asciidoctor-kroki": "^0.10.0",
     "ngrok": "^4.2.2",
-    "serve": "^13.0.2"
+    "serve": "^13.0.2",
+    "yaml": "^2.6.0"
   }
 }