ci: Adding xref validation for PR build

benjaminParisel commented 1 year ago

Use Antora 3.2-alpha for build PR to allow check with atlas validation
Simplify the build-pr-site workflow: no more need to list all dependent component versions

Closes #326 Usage in documentation content repository will be done in #583

Tasks

[x] Check if we can keep Antora 3.1.4 for production build, and run another action to do xref validation with Antora 3.2.0-alpha
[x] Update the build site workflow. Reduce the number of branches or use the preview option allowing to build a single branch for each component (less maintenance). This will validate that the site manifest is used (test the shared action)
[x] Test the update of the build site workflow in bonita-doc https://github.com/bonitasoft/bonita-doc/pull/2416
- [x] validation with a single branch
- [x] ensure errors are still detected
[x] Test no side effect with existing workflow configuration. Do not change the configuration of the preview (multiple components and branches) https://github.com/bonitasoft/bonita-central-doc/pull/29
- [x] no error
- [x] introduce a xref error that should still be detected

Xref validation in documentation content repo

https://github.com/bonitasoft/bonita-doc/pull/2416 with manually introduced errors. See https://github.com/bonitasoft/bonita-doc/actions/runs/5357445602/jobs/9718313232

 [14:29:22.246] ERROR (asciidoctor): target of xref not found: :do-not-exist_for_sure.adoc
    file: modules/ROOT/pages/index.adoc:7
    source: https://github.com/bonitasoft/bonita-doc.git (branch: ci/simplify_xref_validation)
[14:29:22.247] ERROR (asciidoctor): target of xref not found: 3.6@bcd::do-not-exist_for_sure-in-bcd.adoc
    file: modules/ROOT/pages/index.adoc:9
    source: https://github.com/bonitasoft/bonita-doc.git (branch: ci/simplify_xref_validation)

github-actions[bot] commented 1 year ago

🎊 PR Preview 57c2eaa60d5b5988e3b891b76a3bdbbbe8fa6ade has been successfully built and deployed to https://bonitasoft-bonita-documentation-site-test-pr-582.surge.sh

:clock1: Build time: 0.021s