Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make the production build fails when Antora generates warnings #776

Closed
6 tasks done
tbouffard opened this issue Aug 28, 2024 · 0 comments · Fixed by #777
Closed
6 tasks done

Make the production build fails when Antora generates warnings #776

tbouffard opened this issue Aug 28, 2024 · 0 comments · Fixed by #777
Assignees
@tbouffard
Labels
CI ⚙️

Comments

@tbouffard
Copy link
Member

tbouffard commented Aug 28, 2024 •
edited
Loading

As mentioned in #237

The reference validation is done on all Pull Requests for a while. So, new errors should not be introduced.
Notice that if reference errors are found, this doesn't prevent the PR from being merge. So, theoretically, nothing prevents from introducing errors in production but this never happened in the past.

However, it doesn't prevent errors from occurring when porting changes from a version to a new one. This recently happened (see bonitasoft/bonita-doc#2825 for the whole investigation and fix) and broken references (due to missing AsciiDoc attribute) were introduced in production.

In the past, we have only set the production build to fail when Antora generates errors.
There were some old/out-of-support documentation content branches that generated warnings. As they are no longer updated, they prevented to enable "fail on warnings".
Such branches may not exist, and if so, there could be a few warnings to fix.

Tasks

Initial production Logs and warnings detection
@tbouffard tbouffard pinned this issue Aug 28, 2024
@tbouffard tbouffard self-assigned this Aug 28, 2024
@tbouffard tbouffard mentioned this issue Aug 28, 2024
Merged
@tbouffard tbouffard moved this from In Progress to In Review in Bonita documentation site - work in progress Aug 28, 2024
benjaminParisel pushed a commit that referenced this issue Sep 3, 2024
@tbouffard
ci(production): fail the Antora build on warnings (#777)
eb3ce63 
All branches of the documentation content repositories have been
reviewed and fixed to no longer generate warnings. Enabling this feature
will prevent from introducing new warnings without being notified.

This has no impact on preview builds: they already configure the log
level that make the build fail.

### Notes

Closes #776
@benjaminParisel benjaminParisel unpinned this issue Sep 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tbouffard tbouffard

Labels
CI ⚙️
Projects
Bonita documentation site - work in progress
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

ci(production): fail the Antora build on warnings bonitasoft/bonita-documentation-site
1 participant
@tbouffard