-
Notifications
You must be signed in to change notification settings - Fork 117
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
base: master
Are you sure you want to change the base?
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 |
This PR contains the following updates:
^1.27.1
->^2.0.0
Release Notes
Redocly/redocly-cli (@redocly/cli)
v2.0.2
Compare Source
v2.0.1
Compare Source
Patch Changes
no-required-schema-properties-undefined
rule incorrectly resolved nested$ref
s relative to the file in which they were defined.v2.0.0
Compare Source
Major Changes
spec
rule. Usestruct
instead.apiDefinitions
option in the Redocly config. Useapis
instead.Removed the
labels
field within theapis
section, which was associated with the legacy Redocly API Registry product.SpecVersion
,SpecMajorVersion
,OPENAPI3_METHOD
, andOPENAPI3_COMPONENT
enums with types for improved flexibility and type safety.Removed the unused
OasVersion
enum.redocly.yaml
.features.openapi
andfeatures.mockServer
configuration options. Useopenapi
andmockServer
directly instead.lint
andstyleguide
options in the Redocly config.Use
rules
,decorators
and other related options on the root level instead.disallowAdditionalProperties
option support in rules. UseallowAdditionalProperties
instead.theme
property of Redocly config.All the properties of
theme
are now available in the config root.path-excludes-patterns
andinfo-license-url
rules.undefined
assertion. Usedefined
instead.Reunite provides improved API management capabilities and better integration with Redocly's tooling ecosystem.
Migrated the
login
andpush
commands to work exclusively with Reunite.Removed the
preview-docs
command as part of platform modernization.Use the
preview
command instead.referenceDocs
option, which was related to the legacy Reference docs product.extends
bundling 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
StyleguideConfig
class in favor of the unifiedConfig
class.Removed
getMergedConfig
function - useConfig.forAlias()
method instead to retrieve API-specific configurations.Minor Changes
Added
x-security
extension for Respect that enables secure handling of authentication in Arazzo workflows.Use this extension to:
Added validation for JSON Schema format.
Extracted
nullable
validation from thestruct
rule into a newnullable-type-sibling
rule for OpenAPI 3.0. This allows users to disablenullable
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 thetags
field in API descriptions.Enabled
no-required-schema-properties-undefined
,no-schema-type-mismatch
, andno-enum-type-mismatch
rules for AsyncAPI and Arazzo specifications.Adjusted the rules' severities in the
recommended
andminimal
rulesets. Refer to the following table:off
->warn
off
->warn
error
warn
warn
->error
off
->warn
Patch Changes
ignoreLastPathSegment
option of thepath-segment-plural
rule had no effect if the path contained only one segment, resulting in an error.extends
section.@redocly/respect-core
to eliminate Node.js-specific dependencies, improving cross-platform compatibility.residency
from the Redocly configuration file.constructor
property.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.