-
Notifications
You must be signed in to change notification settings - Fork 133
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
Conversation
There was a problem hiding this 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
Lines 79 to 80 in 9519f1f
| "@mdx-js/react": "^3.0.1", | |
| "@redocly/cli": "^2.0.0", |
package.json#L94-L97
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", |
Comment bugbot run to trigger another review on this PR
|
Preview for this PR was built for commit |
9519f1f to
e33b636
Compare
|
Preview for this PR was built for commit |
e33b636 to
6620a3b
Compare
|
Preview for this PR was built for commit |
6620a3b to
b688b28
Compare
|
Preview for this PR was built for commit |
b688b28 to
595edd3
Compare
|
Preview for this PR was built for commit |
595edd3 to
b35eb82
Compare
|
Preview for this PR was built for commit |
b35eb82 to
fa7b8e1
Compare
|
Preview for this PR was built for commit |
fa7b8e1 to
ab8b7e5
Compare
|
Preview for this PR was built for commit |
ab8b7e5 to
898219e
Compare
|
Preview for this PR was built for commit |
898219e to
a8b0088
Compare
|
Preview for this PR was built for commit |
a8b0088 to
6761fc4
Compare
|
Preview for this PR was built for commit |
6761fc4 to
a9d2aff
Compare
|
Preview for this PR was built for commit |
a9d2aff to
7897223
Compare
|
Preview for this PR was built for commit |
7897223 to
86425c7
Compare
|
Preview for this PR was built for commit |
86425c7 to
f044835
Compare
|
Preview for this PR was built for commit |
cd76020 to
1a814cd
Compare
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
e3b52f8 to
9c47cd9
Compare
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
9c47cd9 to
afbc636
Compare
|
Preview for this PR was built for commit |
afbc636 to
658a9bd
Compare
|
Preview for this PR was built for commit |
658a9bd to
1df55f5
Compare
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
|
||
| theme: | ||
| openapi: | ||
| htmlTemplate: openapi/docs/index.html |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we can drop this too (as well as the file), its no longer user for anything
Edited/Blocked NotificationRenovate will not automatically rebase this PR, because it does not recognize the last commit author and assumes somebody else may have edited the PR. You can manually request rebase by checking the rebase/retry box above. |
This PR contains the following updates:
^1.27.1->^2.0.0Release Notes
Redocly/redocly-cli (@redocly/cli)
v2.5.0Compare Source
Minor Changes
Respectterminal and JSON file outputs.Patch Changes
v2.4.0Compare Source
Minor Changes
no-secrets-maskingoption to the respect command, allowing raw (unmasked) output to be generated.Patch Changes
v2.3.1Compare Source
Patch Changes
Respect.v2.3.0Compare Source
Minor Changes
Patch Changes
v2.2.3Compare Source
Patch Changes
v2.2.2Compare Source
Patch Changes
v2.2.1Compare Source
Patch Changes
remove-unused-componentsdecorator was not functioning when configured at the API level.v2.2.0Compare Source
Minor Changes
totalTimeMsto sum the network request times of all steps.Patch Changes
v2.1.5Compare Source
v2.1.4Compare Source
Patch Changes
remove-unused-componentsdecorator, which prevented an invalid reference error from being reported.v2.1.3Compare Source
Patch Changes
scorecard.fromProjectUrl.v2.1.2Compare Source
Patch Changes
v2.1.1Compare Source
Patch Changes
v2.1.0Compare Source
Minor Changes
Patch Changes
pushandpush-statuscommands mistakenly requiring the--max-execution-timeoption.v2.0.8Compare Source
Patch Changes
v2.0.7Compare Source
Patch Changes
v2.0.6Compare Source
Patch Changes
The resolution logic now properly locates the specified files relative to the config file for
info-description-override,media-type-examples-override,operation-description-override, andtag-description-overridedecorators.retryAfterproperty in Respect to use seconds (instead of milliseconds) for consistency with the Arazzo specification.v2.0.5Compare Source
Patch Changes
apisconfig.null.v2.0.4Compare Source
Patch Changes
openapiconfig options were ignored when running thebuild-docscommand.externalRefResolveroption is correctly passed to nested workflow contexts.v2.0.3Compare Source
Patch Changes
inputandserveroptions to support both string and string[] values.Respectresults by properly encoding it as base64.v2.0.2Compare Source
v2.0.1Compare Source
Patch Changes
no-required-schema-properties-undefinedrule incorrectly resolved nested$refs relative to the file in which they were defined.v2.0.0Compare Source
Major Changes
specrule. Usestructinstead.apiDefinitionsoption in the Redocly config. Useapisinstead.Removed the
labelsfield within theapissection, which was associated with the legacy Redocly API Registry product.SpecVersion,SpecMajorVersion,OPENAPI3_METHOD, andOPENAPI3_COMPONENTenums with types for improved flexibility and type safety.Removed the unused
OasVersionenum.redocly.yaml.features.openapiandfeatures.mockServerconfiguration options. UseopenapiandmockServerdirectly instead.lintandstyleguideoptions in the Redocly config.Use
rules,decoratorsand other related options on the root level instead.disallowAdditionalPropertiesoption support in rules. UseallowAdditionalPropertiesinstead.themeproperty of Redocly config.All the properties of
themeare now available in the config root.path-excludes-patternsandinfo-license-urlrules.undefinedassertion. Usedefinedinstead.Reunite provides improved API management capabilities and better integration with Redocly's tooling ecosystem.
Migrated the
loginandpushcommands to work exclusively with Reunite.Removed the
preview-docscommand as part of platform modernization.Use the
previewcommand instead.referenceDocsoption, which was related to the legacy Reference docs product.extendsbundling and array-based plugin configuration.Fixed the extends order in the configuration.
assert/prefix in configurable rules. Userule/prefix instead.Update to Node.js version 20.19.0+, 22.12.0+, or 23+.
Removed
StyleguideConfigclass in favor of the unifiedConfigclass.Removed
getMergedConfigfunction - useConfig.forAlias()method instead to retrieve API-specific configurations.Minor Changes
Added
x-securityextension for Respect that enables secure handling of authentication in Arazzo workflows.Use this extension to:
Added validation for JSON Schema format.
Extracted
nullablevalidation from thestructrule into a newnullable-type-siblingrule for OpenAPI 3.0. This allows users to disablenullablevalidation separately from other structural checks.Configured the
specruleset for OpenAPI, AsyncAPI, Arazzo, and Overlay specifications.This ruleset is designed to strictly follow the specifications.
Added the
no-duplicated-tag-namesrule to check for duplications in thetagsfield in API descriptions.Enabled
no-required-schema-properties-undefined,no-schema-type-mismatch, andno-enum-type-mismatchrules for AsyncAPI and Arazzo specifications.Adjusted the rules' severities in the
recommendedandminimalrulesets. Refer to the following table:off->warnoff->warnerrorwarnwarn->erroroff->warnPatch Changes
ignoreLastPathSegmentoption of thepath-segment-pluralrule had no effect if the path contained only one segment, resulting in an error.extendssection.@redocly/respect-coreto eliminate Node.js-specific dependencies, improving cross-platform compatibility.residencyfrom the Redocly configuration file.constructorproperty.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.
This PR was generated by Mend Renovate. View the repository job log.