Last updated

reunite

Allow builds to publish even if Reunite detects the following in your project:

  • Broken links.
  • Noncompliant API descriptions.
  • Markdoc syntax errors.

Options

OptionType Description
ignoreLinkCheckerbooleanPublish a production project, even if Reunite detects broken links. Default value: false.
ignoreLintboolean | objectPublish a production project, even if Reunite detects an API description in the project that scores below the minimum standard set either by the scorecard or api options in the redocly.yaml file. Default value: false.
ignoreMarkdocErrorsbooleanPublish a production project, even if Reunite detects Markdoc syntax errors. Default value: false.

Examples

Ignore errors examples

The following example configuration 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

You can also ignore specific API description files by making the ignoreLint option an object, as in the following example configuration:

redocly.yaml
reunite:
  ignoreLinkChecker: true
  ignoreLint:
    docs/museum/**: true
    docs/travel.yaml: true

The errors are still reported, but they do 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.
 
Next page