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 yourredocly.yaml
file.
Options
Option | Type | Description |
---|---|---|
ignoreLinkChecker | boolean | Allows to you to publish a production project, even if Reunite detects broken links. Default value: false . |
ignoreLint | boolean or object | Allows 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 . |
ignoreMarkdocErrors | boolean | Allows 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
Or when the ignoreLint
flag is an object:
redocly.yaml
reunite: ignoreLinkChecker: true ignoreLint: docs/museum/**: true docs/travel.yaml: true
The errors will still be reported, but they will not prevent publishing.
Related options
- 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.