-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: Oliver Howell <[email protected]> Co-authored-by: Anatolii Zhmaiev <[email protected]>
- Loading branch information
3 people
authored
Nov 15, 2024
1 parent
b34dc81
commit 5f3522d
Showing
6 changed files
with
155 additions
and
61 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # These owners will be the default owners for everything in | ||
| # the repo | ||
| * @Serdaro | ||
| * @oliverhowell @amandalindsay @Rob-Hazelcast |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| name: Validate | ||
| description: Check for dead links | ||
|
|
||
| runs: | ||
| using: 'composite' | ||
| steps: | ||
| - uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 20 | ||
| cache: 'npm' | ||
|
|
||
| - name: Checkout global antora-playbook | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| repository: hazelcast/hazelcast-docs | ||
| sparse-checkout: | | ||
| antora-playbook.yml | ||
| lib/load-check-links-playbook.js | ||
| sparse-checkout-cone-mode: false | ||
| path: hazelcast-docs | ||
| ref: main | ||
|
|
||
| - name: Check for broken internal links | ||
| shell: bash | ||
| run: | | ||
| cp "./hazelcast-docs/lib/load-check-links-playbook.js" "./load-check-links-playbook.js" | ||
| npm i | ||
| npm i -D [email protected] | ||
| node load-check-links-playbook.js $GITHUB_REPOSITORY $GITHUB_BASE_REF | ||
| ./node_modules/.bin/antora --fetch --to-dir test --log-level=error --log-failure-level=error --extension=@jcahills/antora-link-checker check-links-playbook.yml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| const YAML = require('yaml'); | ||
| const fs = require('fs'); | ||
|
|
||
| const [currentRepoName, baseBranchName] = process.argv.slice(-2); | ||
|
|
||
| console.log('Checking links...'); | ||
|
|
||
| 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 hazelcast-mono & management-center, | ||
| // because they have only Swagger docs thus will never have links to the current | ||
| // and also they require authentication | ||
| 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 target branch from the global content list | ||
| const currentRepoSource = globalSources.find(source => source.url.endsWith(currentRepoName)); | ||
| currentRepoSource.branches.push(`!${baseBranchName}`); | ||
|
|
||
| // 4. Replace local content.sources with the modified content.sources | ||
| localAntoraPlaybook.content.sources = globalSources; | ||
| const checkLinksPlaybook = YAML.stringify(localAntoraPlaybook); | ||
|
|
||
| fs.writeFileSync( | ||
| './check-links-playbook.yml', | ||
| checkLinksPlaybook, | ||
| { encoding: 'utf8' }, | ||
| ); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,5 @@ | ||
| name: templates | ||
| title: Templates | ||
| version: v0.1 | ||
| nav: | ||
| - modules/ROOT/nav.adoc | ||
|
|
||
|
|