Skip to content

Commit

Permalink
fix(docs): improve error messages related to docs.yml parsing (#5714)
Browse files Browse the repository at this point in the history
  • Loading branch information
dsinghvi authored Jan 23, 2025
1 parent 48aef74 commit 63267c2
Show file tree
Hide file tree
Showing 12 changed files with 4,733 additions and 60 deletions.
5 changes: 5 additions & 0 deletions fern/pages/changelogs/cli/2025-01-23.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
## 0.51.2
**`(fix):`** Improved error messages when docs.yml doesn't match schema by showing more specific
validation errors and including the path where the error occurred.


5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,12 @@
"fern-local:build": "pnpm --filter @fern-api/cli dist:cli:local && echo 'Run node packages/cli/cli/dist/local/cli.cjs'",
"seed:build": "pnpm --filter @fern-api/seed-cli dist:cli && echo 'Run packages/seed/dist/cli.cjs'",
"publish": "pnpm -r publish --access public --no-git-checks --loglevel=verbose",
"jsonschema": "pnpm definition-yml:jsonschema && pnpm api-yml:jsonschema && pnpm package-yml:jsonschema && pnpm docs-yml:jsonschema && pnpm generators-yml:jsonschema",
"jsonschema": "pnpm definition-yml:jsonschema && pnpm api-yml:jsonschema && pnpm package-yml:jsonschema && pnpm docs-yml:jsonschema && pnpm generators-yml:jsonschema && pnpm versions-yml:jsonschema",
"definition-yml:jsonschema": "pnpm fern jsonschema fern.schema.json --api fern-definition --type file.DefinitionFileSchema && pnpm fern jsonschema packages/cli/workspace/lazy-fern-workspace/src/fern.schema.json --api fern-definition --type file.DefinitionFileSchema",
"api-yml:jsonschema": "pnpm fern jsonschema api-yml.schema.json --api fern-definition --type file.RootApiFileSchema && pnpm fern jsonschema packages/cli/workspace/lazy-fern-workspace/src/api-yml.schema.json --api fern-definition --type file.RootApiFileSchema",
"package-yml:jsonschema": "pnpm fern jsonschema package-yml.schema.json --api fern-definition --type file.PackageMarkerFileSchema && pnpm fern jsonschema packages/cli/workspace/lazy-fern-workspace/src/package-yml.schema.json --api fern-definition --type file.PackageMarkerFileSchema",
"docs-yml:jsonschema": "pnpm fern jsonschema docs-yml.schema.json --api docs-yml --type docs.DocsConfiguration",
"docs-yml:jsonschema": "pnpm fern jsonschema docs-yml.schema.json --api docs-yml --type docs.DocsConfiguration && pnpm fern jsonschema packages/cli/workspace/loader/src/docs-yml.schema.json --api docs-yml --type docs.DocsConfiguration",
"versions-yml:jsonschema": "pnpm fern jsonschema packages/cli/yaml/docs-validator/src/docsAst/versions-yml.schema.json --api docs-yml --type docs.VersionFileConfig",
"generators-yml:jsonschema": "pnpm fern jsonschema generators-yml.schema.json --api generators-yml --type generators.GeneratorsConfigurationSchema",
"check-cli-release-blockers": "pnpm fern-script check-cli-release-blockers",
"check-docs-release-blockers": "pnpm fern-script check-docs-release-blockers",
Expand Down
8 changes: 8 additions & 0 deletions packages/cli/cli/versions.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
- changelogEntry:
- summary: |
Improved error messages when docs.yml doesn't match schema by showing more specific
validation errors and including the path where the error occurred.
type: fix
irVersion: 55
version: 0.51.2

- changelogEntry:
- summary: |
Fixed x-fern-resolutions to properly handle escaped forward slashes ("~1") in schema references,
Expand Down
Loading

0 comments on commit 63267c2

Please sign in to comment.