Skip to content

Commit afe30fe

Browse files
authored
Remove the unused bundle/docsgen documentation generator (#5568)
`bundle/docsgen` (added in #2033) generated the DABs configuration reference markdown. It has been superseded by the docs-only JSON schema added in #4414 (`bundle/schema/jsonschema_for_docs.json`), which is now the source of truth for the published documentation; docsgen's output is no longer consumed anywhere. This removes the package along with its call sites and references across the repository. This pull request and its description were written by Isaac.
1 parent ed5cf3a commit afe30fe

20 files changed

Lines changed: 4 additions & 19752 deletions

.agent/rules/auto-generated-files.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ globs:
1414
- "internal/genkit/tagging.py"
1515
- "internal/mocks/**/*.go"
1616
- "bundle/direct/dresources/*.generated.yml"
17-
- "bundle/docsgen/output/**/*.md"
1817
- "bundle/internal/schema/annotations_openapi.yml"
1918
- "bundle/internal/validation/generated/*.go"
2019
- "bundle/schema/jsonschema.json"
@@ -36,7 +35,6 @@ paths:
3635
- "internal/genkit/tagging.py"
3736
- "internal/mocks/**/*.go"
3837
- "bundle/direct/dresources/*.generated.yml"
39-
- "bundle/docsgen/output/**/*.md"
4038
- "bundle/internal/schema/annotations_openapi.yml"
4139
- "bundle/internal/validation/generated/*.go"
4240
- "bundle/schema/jsonschema.json"
@@ -75,8 +73,6 @@ Files matching this rule's glob pattern are most likely generated artifacts. Aut
7573
- `./task generate-schema`
7674
- `./task generate-schema-docs`
7775
- This can also refresh `bundle/internal/schema/annotations_openapi.yml` when OpenAPI annotation extraction is enabled.
78-
- Bundle docs:
79-
- `./task generate-docs`
8076
- Validation generated code:
8177
- `./task generate-validation`
8278
- Mock files:

.golangci.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,6 @@ linters:
6262
no-stdlib-log:
6363
files:
6464
- "**"
65-
- "!**/bundle/docsgen/**"
6665
- "!**/bundle/internal/schema/**"
6766
- "!**/bundle/internal/tf/codegen/**"
6867
- "!**/bundle/internal/validation/**"

.wsignore

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,3 @@ python/databricks/bundles/*/_models/*.py
2626

2727
# Developed elsewhere:
2828
internal/genkit/tagging.py
29-
30-
# Docsgen:
31-
bundle/docsgen/output/resources.md
32-
bundle/docsgen/output/reference.md
33-
bundle/docsgen/testdata/anchors.md

AGENTS.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,6 @@ This is the Databricks CLI, a command-line interface for interacting with Databr
4040
### Specialized Commands
4141

4242
- `./task generate-schema` - Generate bundle JSON schema
43-
- `./task generate-docs` - Generate bundle documentation
4443
- `./task generate-cligen` - Regenerate CLI command stubs from the checked-in .codegen/cli.json
4544
- `./task generate-clijson` - Refresh .codegen/cli.json from the OpenAPI spec via genkit (requires universe repo)
4645
- `./task generate` - Run all generators

Taskfile.yml

Lines changed: 4 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@ tasks:
5757
- task: generate-schema-map
5858
- task: generate-schema-docs
5959
- task: generate-validation
60-
- task: generate-docs
6160
- task: generate-direct
6261
- task: pydabs-codegen
6362
- task: pydabs-lint
@@ -743,7 +742,6 @@ tasks:
743742
- task: generate-schema
744743
- task: generate-schema-docs
745744
- task: generate-validation
746-
- task: generate-docs
747745
- task: generate-direct
748746
- task: pydabs-codegen
749747

@@ -765,7 +763,6 @@ tasks:
765763
- task: generate-refschema
766764
- task: generate-schema
767765
- task: generate-validation
768-
- task: generate-docs
769766
- task: generate-direct
770767
- task: pydabs-codegen
771768

@@ -861,12 +858,12 @@ tasks:
861858

862859
# Regenerates the OpenAPI annotation files (annotations_openapi*.yml) from the
863860
# checked-in .codegen/cli.json. This is the step that propagates a cli.json
864-
# change into the schema/docs artifacts: generate-schema, generate-schema-docs
865-
# and generate-docs all depend on it, so editing cli.json and running
866-
# `task generate` percolates into jsonschema.json, the docs and pydabs.
861+
# change into the schema/docs artifacts: generate-schema and generate-schema-docs
862+
# both depend on it, so editing cli.json and running `task generate`
863+
# percolates into jsonschema.json, jsonschema_for_docs.json and pydabs.
867864
generate-annotations:
868865
desc: Regenerate annotation files from .codegen/cli.json
869-
# Dep of generate-schema, generate-schema-docs and generate-docs; `run: once`
866+
# Dep of generate-schema and generate-schema-docs; `run: once`
870867
# plus the fingerprint keep `task generate` from re-running it per parent.
871868
run: once
872869
sources:
@@ -913,23 +910,6 @@ tasks:
913910
- git fetch origin 'refs/tags/v*:refs/tags/v*'
914911
- "go run ./bundle/internal/schema ./bundle/internal/schema ./bundle/schema/jsonschema_for_docs.json --docs"
915912

916-
generate-docs:
917-
desc: Generate bundle documentation
918-
deps: ['generate-annotations']
919-
sources:
920-
- "**/*.go"
921-
- bundle/docsgen/templates/**
922-
- bundle/internal/schema/annotations*.yml
923-
- exclude: "**/*_test.go"
924-
- go.mod
925-
- go.sum
926-
- "{{.EMBED_SOURCES}}"
927-
generates:
928-
- bundle/docsgen/output/reference.md
929-
- bundle/docsgen/output/resources.md
930-
cmds:
931-
- "go run ./bundle/docsgen ./bundle/internal/schema ./bundle/docsgen"
932-
933913
generate-validation:
934914
desc: Generate enum and required field validation code
935915
sources:

bundle/docsgen/README.md

Lines changed: 0 additions & 79 deletions
This file was deleted.

bundle/docsgen/main.go

Lines changed: 0 additions & 148 deletions
This file was deleted.

0 commit comments

Comments
 (0)