Skip to content

chore(deps): update dependency @redocly/cli to v2 #1723

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Jul 24, 2025

This PR contains the following updates:

Package Change Age Confidence
@redocly/cli ^1.27.1 -> ^2.0.0 age confidence

Release Notes

Redocly/redocly-cli (@​redocly/cli)

v2.0.2

Compare Source

Patch Changes
  • Made executionTimeout parameter optional in the run function exported from respect-core.
  • Updated @​redocly/respect-core to v2.0.2.

v2.0.1

Compare Source

Patch Changes
  • Fixed an issue where the no-required-schema-properties-undefined rule incorrectly resolved nested $refs relative to the file in which they were defined.
  • Fixed an issue where multipart form-data parameters were not properly resolved and evaluated before sending requests.
  • Updated @​redocly/openapi-core to v2.0.1.

v2.0.0

Compare Source

Major Changes
  • Removed backward compatibility for the spec rule. Use struct instead.
  • Removed support for the deprecated apiDefinitions option in the Redocly config. Use apis instead.
    Removed the labels field within the apis section, which was associated with the legacy Redocly API Registry product.
  • Removed support for default config file names other than redocly.yaml.
  • Removed support for the deprecated features.openapi and features.mockServer configuration options. Use openapi and mockServer directly instead.
  • Removed backward compatibility for the deprecated lint and styleguide options in the Redocly config.
    Use rules, decorators and other related options on the root level instead.
  • Removed the deprecated disallowAdditionalProperties option support in rules. Use allowAdditionalProperties instead.
  • Removed support for the deprecated theme property of Redocly config.
    All the properties of theme are now available in the config root.
  • Removed the deprecated path-excludes-patterns and info-license-url rules.
  • Removed the deprecated undefined assertion. Use defined instead.
  • Removed support for the legacy Redocly API Registry in favor of the new Reunite platform.
    Reunite provides improved API management capabilities and better integration with Redocly's tooling ecosystem.
    Migrated the login and push commands to work exclusively with Reunite.
    Removed the preview-docs command as part of platform modernization.
    Use the preview command instead.
  • Removed support for the deprecated referenceDocs option, which was related to the legacy Reference docs product.
  • Removed support for the deprecated assert/ prefix in configurable rules. Use rule/ prefix instead.
  • Migrated the codebase to ES Modules from CommonJS, bringing improved code organization and better support for modern JavaScript features.
    Update to Node.js version 20.19.0+, 22.12.0+, or 23+.
Minor Changes
  • Added x-security extension for Respect that enables secure handling of authentication in Arazzo workflows.
    Use this extension to:

    • Define security schemes at the step level using either predefined schemes or inline definitions
    • Pass values of secrets (passwords, tokens, API keys)
    • Support multiple authentication types including API Key (query, header, or cookie), Basic Authentication, Bearer Token, Digest Authentication, OAuth2, and OpenID Connect
    • Automatically transform security parameters into appropriate HTTP headers or query parameters
  • Added environment variable support for CLI arguments using Yargs .env() method to parse environment variables with matching prefixes.

  • Added validation for JSON Schema format.

  • Extracted nullable validation from the struct rule into a new nullable-type-sibling rule for OpenAPI 3.0. This allows users to disable nullable validation separately from other structural checks.

  • Configured the spec ruleset for OpenAPI, AsyncAPI, Arazzo, and Overlay specifications.
    This ruleset is designed to strictly follow the specifications.

  • Added the no-duplicated-tag-names rule to check for duplications in the tags field in API descriptions.

  • Enabled no-required-schema-properties-undefined, no-schema-type-mismatch, and no-enum-type-mismatch rules for AsyncAPI and Arazzo specifications.
    Adjusted the rules' severities in the recommended and minimal rulesets. Refer to the following table:

    Rule \ Ruleset recommended minimal
    no-required-schema-properties-undefined off -> warn off -> warn
    no-enum-type-mismatch error warn
    no-schema-type-mismatch warn -> error off -> warn
  • Implemented automatic masking of sensitive fields (such as tokens and passwords) in response bodies to enhance security and prevent accidental exposure of secrets in logs and outputs.

  • Added new CLI options for the respect command to improve test execution control.

Patch Changes
  • Fixed plugins validation in config files referenced in the extends section.
  • Fixed no-undefined-server-variable crash when encountering null values in the server list.
  • Refactored @redocly/respect-core to eliminate Node.js-specific dependencies, improving cross-platform compatibility.
  • Updated Redoc to v2.5.0.
  • Fixed alias detection when using --config from a different folder than the current working directory.
  • Resolved an issue where [email protected] injected an unintended message into the output.
  • Fixed Redocly CLI to correctly read residency from the Redocly configuration file.
  • Improved Respect's error handling when server URLs are missing from both OpenAPI descriptions and CLI options.
  • Updated @​redocly/respect-core to v2.0.0.

Configuration

📅 Schedule: Branch creation - "every weekday" (UTC), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: Redocly CLI Update Breaks Node.js 18 Compatibility

Node.js version incompatibility introduced by the @redocly/cli v2.0.0 update. The project's package.json specifies engines.node: ">=18.0.0", but the new @redocly/cli requires node: ">=22.12.0 || >=20.19.0 <21.0.0". This prevents users on Node.js 18.x or 19.x from installing or running redocly commands, leading to build or runtime failures.

package.json#L79-L80

apify-docs/package.json

Lines 79 to 80 in 9519f1f

"@mdx-js/react": "^3.0.1",
"@redocly/cli": "^2.0.0",

package.json#L94-L97

apify-docs/package.json

Lines 94 to 97 in 9519f1f

"react": "^19.1.0",
"react-dom": "^19.1.0",
"react-github-btn": "^1.4.0",
"search-insights": "2.17.3",

Fix in CursorFix in Web


Comment bugbot run to trigger another review on this PR

@apify-service-account
Copy link

Preview for this PR was built for commit 9519f1f and is ready at https://pr-1723.preview.docs.apify.com!

@renovate renovate bot force-pushed the renovate/redocly-cli-2.x branch from 9519f1f to e33b636 Compare July 25, 2025 17:55
@apify-service-account
Copy link

Preview for this PR was built for commit e33b636 and is ready at https://pr-1723.preview.docs.apify.com!

@renovate renovate bot force-pushed the renovate/redocly-cli-2.x branch from e33b636 to 6620a3b Compare July 29, 2025 09:08
@apify-service-account
Copy link

Preview for this PR was built for commit 6620a3b and is ready at https://pr-1723.preview.docs.apify.com!

@renovate renovate bot force-pushed the renovate/redocly-cli-2.x branch from 6620a3b to b688b28 Compare July 30, 2025 16:28
@apify-service-account
Copy link

Preview for this PR was built for commit b688b28 and is ready at https://pr-1723.preview.docs.apify.com!

@renovate renovate bot force-pushed the renovate/redocly-cli-2.x branch from b688b28 to 595edd3 Compare July 30, 2025 23:59
@apify-service-account
Copy link

Preview for this PR was built for commit 595edd3 and is ready at https://pr-1723.preview.docs.apify.com!

@renovate renovate bot force-pushed the renovate/redocly-cli-2.x branch from 595edd3 to b35eb82 Compare August 2, 2025 03:50
@apify-service-account
Copy link

Preview for this PR was built for commit b35eb82 and is ready at https://pr-1723.preview.docs.apify.com!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant