Repository navigation
refactor: harden the docs sync and apply review fixes - #1
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes from code, simplify and security reviews of the initial commit.
Sync script
?querypath keys during the merge, so they go through the conflict check instead of a separate overwrite pass.openapi/.--checknow compares the split output file-by-file againstopenapi/instead of bundling and comparing sorted JSON.redoclybinary instead ofnpx redocly(which can resolve to an unrelated npm package).isDeepStrictEqualfor comparisons.__proto__,constructorandprototypekeys from docs YAML.Spec and tooling
infoblock override moves from the sync script into a Redoclyinfo-overridedecorator, soopenapi/is again an exact copy of the docs and only the release files carry the Nomba title, contact and license.nombaAPI alias fromredocly.yaml.preview(preview-docsno longer exists in Redocly CLI 2.x) withdocs, which rendersdist/index.html.CI
setup-node.package.json's version.Docs
Verified locally:
npm run lint,npm run bundle,npm run docs,npm run sync -- --check(exit 0 when clean, exit 1 after editing a file underopenapi/).