Redocly / developer-portal-starter

Starter template for the Redocly developer portal
https://redoc.ly
Other
64 stars 101 forks source link

The build command fails with zero information on errors #249

Closed aditya-docs closed 1 year ago

aditya-docs commented 1 year ago

image

We recently purchased the developer portal but need help running the build command. Almost always, the builds fail, and we could deploy the portal only once. The error messages need to include information on why the build failed. Here is an example above. ^^^ I Need a support person to set up a call to explain how we can make the portal builds a smooth process. Our org id is tray-docs-gto

romanpryshliak commented 1 year ago

Hi @aditya-docs,

Thank you for reaching out.

Upon reviewing the portal build, I can see that the cause of its failure is the following error:

error Bundled definition with errors at openapi/openapi.yaml.

This error means that the openapi.yaml OpenAPI definition file is not valid and, therefore, the portal build failed.

To avoid similar issues in the future, I would recommend conducting a local linting of your OpenAPI definition files prior to pushing changes to production.

To accomplish this task, you can use the Redocly CLI, which enables you to validate the OpenAPI definition files locally and identify errors. You can refer to the following links for more information:

https://redoc.ly/docs/cli/quickstart/ https://redoc.ly/docs/cli/installation/ https://redoc.ly/docs/cli/commands/lint/

If you have any further questions, please don't hesitate to contact us at team@redocly.com.