Skip to content

docs schema: drop jsonschema_for_docs.json from main, keep on docgen#5388

Draft
shreyas-goenka wants to merge 1 commit into
databricks:mainfrom
shreyas-goenka:shreyas-goenka/docs-schema-docgen-only
Draft

docs schema: drop jsonschema_for_docs.json from main, keep on docgen#5388
shreyas-goenka wants to merge 1 commit into
databricks:mainfrom
shreyas-goenka:shreyas-goenka/docs-schema-docgen-only

Conversation

@shreyas-goenka
Copy link
Copy Markdown
Contributor

@shreyas-goenka shreyas-goenka commented May 31, 2026

Move bundle/schema/jsonschema_for_docs.json off main — it's now read from the docgen branch (published by update-schema-docs.yml per release). Generation stays scoped to that release workflow.

  • Delete the committed file from main.
  • Drop generate-schema-docs from the generate/all aggregators; keep the task def (the release workflow invokes it).
  • update-schema-docs.yml: regen now yields an untracked file, so the assertion checks ?? not M.
  • Remove stale refs in .wsignore, .gitattributes, .agent/rules/auto-generated-files.md.

jsonschema.json (embedded, used by codegen) is untouched.

This pull request and its description were written by Isaac.

@shreyas-goenka shreyas-goenka changed the title Stop committing jsonschema_for_docs.json on main; keep it on the docgen branch only docs schema: drop jsonschema_for_docs.json from main, keep on docgen May 31, 2026
The docs schema (`bundle/schema/jsonschema_for_docs.json`) is consumed only
by the DABs docs tooling, which now reads it from the `docgen` branch. There
is no reason to carry the generated file on `main` or to regenerate it during
the normal local codegen flow:

- Delete the committed `bundle/schema/jsonschema_for_docs.json` from `main`.
- Drop `generate-schema-docs` from the `generate` and `all` aggregators so
  `./task generate` no longer produces it. The task definition stays — the
  update-schema-docs release workflow still invokes it directly — and gains a
  note warning against re-adding it to an aggregator.
- update-schema-docs.yml: regeneration now creates the file as an untracked
  artifact (it is no longer tracked on `main`), so the post-regen assertion
  checks for `?? ...` instead of ` M ...`, and an empty status is now an error.
- Remove the now-stale references to the file from `.wsignore`,
  `bundle/schema/.gitattributes`, and `.agent/rules/auto-generated-files.md`.

`bundle/schema/jsonschema.json` (the canonical schema, embedded in the binary
and used by Python codegen) is unaffected.

Co-authored-by: Isaac
@shreyas-goenka shreyas-goenka force-pushed the shreyas-goenka/docs-schema-docgen-only branch from 5c4276b to c2349bd Compare May 31, 2026 23:34
@github-actions
Copy link
Copy Markdown
Contributor

An authorized user can trigger integration tests manually by following the instructions below:

Trigger:
go/deco-tests-run/cli

Inputs:

  • PR number: 5388
  • Commit SHA: c2349bd2a665f69f89d7f27614f6f81a5a7e4c7e

Checks will be approved automatically on success.

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