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

[Bug] doc generation fails if api.yml is missing #4212

Closed
ammubhave opened this issue Aug 5, 2024 · 2 comments
Closed

[Bug] doc generation fails if api.yml is missing #4212

ammubhave opened this issue Aug 5, 2024 · 2 comments
Assignees
Labels
product/docs Fern Docs which builds and hosts a developer documentation site

Comments

@ammubhave
Copy link

ammubhave commented Aug 5, 2024

Describe the Bug

We use fern to generate docs for a site which does not have any api. Previously if there is no api.yml file, the doc generation would still succeed. Now the cli exits without non-zero status code, and needs a dummy definition/api.yml file with a name key.

Information to Reproduce

CLI Version

0.37.6

Actual Behavior

exits with non-zero code and doc generation fails

[docs]: Found 0 errors and 1 warnings. Run fern check --warnings to print out the warnings.
[docs]: Missing file: api.yml

Expected Behavior

doc generation suceeds

@ammubhave ammubhave added the product/docs Fern Docs which builds and hosts a developer documentation site label Aug 5, 2024
@dsinghvi
Copy link
Member

dsinghvi commented Aug 5, 2024

#4206 @ammubhave this is being fixed in the linked PR!

@dsinghvi dsinghvi assigned abarrell and unassigned abvthecity Aug 5, 2024
@dsinghvi
Copy link
Member

dsinghvi commented Aug 7, 2024

@ammubhave this is released in the latest CLI

@dsinghvi dsinghvi closed this as completed Aug 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
product/docs Fern Docs which builds and hosts a developer documentation site
Development

No branches or pull requests

4 participants