chore: add a tool to check links [POC] #618
Draft
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
WIP
Covers #430.
Use
htmltest
: https://github.com/wjdp/htmltestConfiguration of the preview script use to build the site that is checked. This is why we are not using the production build for the checks:
The GH workflow enables the real use of Antora Atlas to resolve links to pages not built in the preview (links to pages related to unsupported versions). This may consume extra bandwidth in our Netlify plan.
Remaining tasks
IgnoreURLs
option - IgnoreDirs cannot be used as the dependencies pages are located in the ROOT module at the root of the directory.Example of preview commands to generate the site to check locally
Single component version
Note:
Build whole site (include bonita out of support version)
Command to only build supported versions
The real check requires to enable Antora Atlas.
Otherwise, some cross references are not resolved like
WARN: missing ref for bonita 2021.1 - some content have xref to this version
./build-preview-dev.bash \ --hide-edit-page-links true \ --force-production-navbar \ --type links-check \ --use-multi-repositories \ --component-with-branches bcd:3.6,4.0 \ --component-with-branches bonita:archives,2021.2,2022.1,2022.2,2023.1,2023.2 \ --component-with-branches central:1.0 \ --component-with-branches cloud:master \ --component-with-branches labs:master \ --component-with-branches test-toolkit:1.0,2.0 \ --local-sources
Output
Installation options