Improve nanoc ERROR summaries
Context
In this failed docs-lint links
job I tried our AI "Root cause analysis" again after some time of avoiding it. It's still mostly wrong, but highlights some areas of improvement.
Improvement idea
Can nanoc
errors be printed as a single block of lines at the very end of the job log? This would also help with "Failed jobs" tab shows incomplete stacktraces (gitlab#423443) generally, see the job's pipeline failures. That should show:
Issues found!
(global):
[ ERROR ] internal_links - broken reference to file:///tmp/gitlab-docs/public/ee/project/repository/index.html
[ ERROR ] internal_anchors - Broken anchor detected!
- source file `/tmp/gitlab-docs/public/ee/user/profile/account/delete_account.html`
- destination `/tmp/gitlab-docs/public/ee/project/repository/index.html`
- link `../../../project/repository/index.html#commit-changes-to-a-repository`
- anchor `#commit-changes-to-a-repository`
Error: Two or more checks failed
2 relevant steps
-
Removal of the
offenses found
line could help, because it introduced a difference between theinternal_anchors
and theinternal_links
output structure. In the MR that introduced it, I could find no discussion about thatissue
/offense
count
summary
specifically. Does it serve a vital purpose? cc @grzesiek -
Removal of the
time
command, or switching to parallel --results +cat
ing the resulting output files in an order that would achieve the improvement idea☝ cc @eread