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.

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

Doc build succeeds when it should fail #450

Closed
bmorelli25 opened this issue Feb 7, 2025 · 0 comments · Fixed by #454
Closed

Doc build succeeds when it should fail #450

bmorelli25 opened this issue Feb 7, 2025 · 0 comments · Fixed by #454
Labels
bug build relates to invocation of the tool(s) ci

Comments

@bmorelli25
Copy link
Member

Summary

There's an edge case bug where docs-builder should fail but does not. I'm not sure if this is a bug in docs-builder or in our GH Action.

Example

A writer added two frontmatter sections to a single file in elastic/docs-content#374:

---
mapped_urls:
  - https://www.elastic.co/guide/en/observability/current/apm-act-on-data.html
  - https://www.elastic.co/guide/en/serverless/current/observability-apm-act-on-data.html
---

---
navigation_title: "Act on data"
---

# Act on application data [apm-act-on-data]

The "build documentation" step logs a fail due to an ArgumentNullException:

:: info: DocumentationGenerator[0] Resolving tree
:: fail: Program[0] System.ArgumentNullException: Value cannot be null. (Parameter 'markdown')    at Markdig.Helpers.ThrowHelper.ArgumentNullException_markdown() + 0x27    at Markdig.Markdown.ToPlainText(String, TextWriter, MarkdownPipeline, MarkdownParserContext) + 0xa6    at 
...

However, after that very long error, the docs build exits successfully with:

:: info: Program[0] generate :: Finished in '00:00:00.2889647

This leads to a failure in the Upload Artifact step as there is nothing to upload in .artifacts/docs/html/.

Action logs

Here's the action logs: https://github.com/elastic/docs-content/actions/runs/13207072028/job/36873474178

@bmorelli25 bmorelli25 added bug build relates to invocation of the tool(s) ci labels Feb 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug build relates to invocation of the tool(s) ci
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant