Last updated

reunite

Allow builds to publish even if:

  • Reunite detects broken links
  • Reunite detects an API description in the project that scores below the minimum standard
  • Markdoc errors in your project by configuring the reunite option in your redocly.yaml file.

Options

OptionType Description
ignoreLinkCheckerbooleanAllows to you to publish a production project, even if Reunite detects broken links. Default value: false.
ignoreLintbooleanAllows to you to publish a production project, even if Reunite detects an API description in the project that scores below the minimum standard. Default value: false.
ignoreMarkdocErrorsbooleanAllows to you to publish a production project, even if Reunite detects Markdoc errors. Default value: false.

Examples

The following example allows you to publish production project deploys even if Reunite detects broken links, an API description in the project that scores below the minimum standard, and Markdoc errors:

redocly.yaml
reunite:
  ignoreLinkChecker: true
  ignoreLint: true
  ignoreMarkdocErrors: true

The errors will still be reported, but they will not prevent publishing.

  • You can set this option by environment (preview, development, production) using the env option, to allow builds to continue for development or preview builds, but not for production builds.
  • Grant access to Reunite by teams using the rbac configuration reference documentation.

Resources

  • Learn more about Reunite, Redocly's cloud platform for creating, editing, previewing. and deploying your API documentation projects.
  • Discover how to add links to your project and how to format those links whether they are in the sidebars.yaml file or in versioned content.
 
Next page