feat(script): add a new option to fail the preview on warning

tbouffard commented 1 year ago

In most branches of repositories documentation content, no warning is generated. Warnings are generally due to wrong AsciiDoc attribute expansion and we should enforce that no new warning is added. So, the preview script allows to set the Antora failure_level to warn to make the build fail on warning. The action used to build and publish the preview and the reference validation now allow to fail on warning.

Tasks

[x] document the option in the bash script
[x] option available in the "publish pr preview" action (tested in a workflow with 5e476ef)
[x] use the option in the workflow of the bonita-labs-doc repository as it uses the "publish pr preview" action. https://github.com/bonitasoft/bonita-labs-doc/pull/147
[x] option available in the "build-pr-site" action (tested in a workflow with 8140b8e)
[x] use the option in the workflows in content repo relying on "build-pr-site":
- [x] that don't have warnings:
- [x] https://github.com/bonitasoft/bonita-central-doc/pull/30
- [x] https://github.com/bonitasoft/bonita-test-toolkit-doc/pull/47 (need to fix asciidoctor info logs, see below)
- [x] https://github.com/bonitasoft/bonita-cloud-doc/pull/49
- [x] bonita-doc warnings: should fail. This is the time to fix them. https://github.com/bonitasoft/bonita-doc/pull/2425
- [x] bcd-doc warnings: should fail. This is the time to fix them. https://github.com/bonitasoft/bonita-continuous-delivery-doc/pull/212
[x] uses the options in the documentation-site build-site repo. Willl fail until https://github.com/bonitasoft/bonita-doc/pull/2425 is merged and changes propagated to the latest Bonita version. #599

bcd 3.6 warnings

[13:22:36.231] WARN (asciidoctor): skipping reference to missing attribute: bonita_gid
    file: modules/ROOT/pages/bcd_controller.adoc
    source: https://github.com/bonitasoft/bonita-continuous-delivery-doc.git (branch: ci/simplify_xref_validation)
[13:22:36.231] WARN (asciidoctor): skipping reference to missing attribute: bonita_uid
    file: modules/ROOT/pages/bcd_controller.adoc
    source: https://github.com/bonitasoft/bonita-continuous-delivery-doc.git (branch: ci/simplify_xref_validation)
[13:22:36.232] WARN (asciidoctor): skipping reference to missing attribute: bonita_gid
    file: modules/ROOT/pages/bcd_controller.adoc
    source: https://github.com/bonitasoft/bonita-continuous-delivery-doc.git (branch: ci/simplify_xref_validation)
[13:22:36.388] WARN (asciidoctor): skipping reference to missing attribute: bonita_version
    file: modules/ROOT/pages/livingapp_build_and_deploy_without_docker.adoc
    source: https://github.com/bonitasoft/bonita-continuous-delivery-doc.git (branch: ci/simplify_xref_validation)
[13:22:36.389] WARN (asciidoctor): skipping reference to missing attribute: bonita_version
    file: modules/ROOT/pages/livingapp_build_and_deploy_without_docker.adoc
    source: https://github.com/bonitasoft/bonita-continuous-delivery-doc.git (branch: ci/simplify_xref_validation)
[13:22:36.392] WARN (asciidoctor): skipping reference to missing attribute: deployer_version
    file: modules/ROOT/pages/livingapp_build_and_deploy_without_docker.adoc
    source: https://github.com/bonitasoft/bonita-continuous-delivery-doc.git (branch: ci/simplify_xref_validation)

bonita-test-toolkit asccidoctor info --> xref problems

The job and the step in the workflow should be rename into "validate xref" for consistency with the workflow in the other repositories.

 [12:25:39.944] INFO (asciidoctor): possible invalid reference: _retrieve_contracts_from_files
    file: modules/ROOT/pages/contract.adoc
    source: https://github.com/bonitasoft/bonita-test-toolkit-doc.git (branch: ci/simplify_xref_validation)
[12:25:39.947] INFO (asciidoctor): possible invalid reference: _retrieve_contracts_from_files
    file: modules/ROOT/pages/contract.adoc
    source: https://github.com/bonitasoft/bonita-test-toolkit-doc.git (branch: ci/simplify_xref_validation)
[12:25:40.066] INFO (asciidoctor): possible invalid reference: _task_predicates
    file: modules/ROOT/pages/task.adoc
    source: https://github.com/bonitasoft/bonita-test-toolkit-doc.git (branch: ci/simplify_xref_validation)