synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-12 00:14:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(Makefile): fix apidoc dependencies (#17042)

Browse Source 
Our apidoc generation had some circular dependencies, this change splits
them up into separate Makefile targets.
This commit is contained in:
Mathias Fredriksson
2025-03-21 17:16:17 +02:00
committed by GitHub
parent fe24a7a4a8
commit 3b6bee9676
3 changed files with 30 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored
View File

@ -32,7 +32,8 @@ site/e2e/.auth.json
site/playwright-report/* site/playwright-report/*
site/.swc site/.swc
# Make target for updating golden files (any dir). # Make target for updating generated/golden files (any dir).
.gen
.gen-golden .gen-golden
# Build # Build

32
Makefile
View File

@ -400,6 +400,10 @@ site/node_modules/.installed: site/package.json site/pnpm-lock.yaml
(cd site/ && ../scripts/pnpm_install.sh) (cd site/ && ../scripts/pnpm_install.sh)
touch "$@" touch "$@"
scripts/apidocgen/node_modules/.installed: scripts/apidocgen/package.json scripts/apidocgen/pnpm-lock.yaml
(cd scripts/apidocgen && ../../scripts/pnpm_install.sh)
touch "$@"
SITE_GEN_FILES := \ SITE_GEN_FILES := \
site/src/api/typesGenerated.ts \ site/src/api/typesGenerated.ts \
site/src/api/rbacresourcesGenerated.ts \ site/src/api/rbacresourcesGenerated.ts \
@ -560,6 +564,7 @@ GEN_FILES := \
docs/reference/cli/index.md \ docs/reference/cli/index.md \
docs/admin/security/audit-logs.md \ docs/admin/security/audit-logs.md \
coderd/apidoc/swagger.json \ coderd/apidoc/swagger.json \
docs/manifest.json \
provisioner/terraform/testdata/version \ provisioner/terraform/testdata/version \
site/e2e/provisionerGenerated.ts \ site/e2e/provisionerGenerated.ts \
examples/examples.gen.json \ examples/examples.gen.json \
@ -607,6 +612,7 @@ gen/mark-fresh:
docs/reference/cli/index.md \ docs/reference/cli/index.md \
docs/admin/security/audit-logs.md \ docs/admin/security/audit-logs.md \
coderd/apidoc/swagger.json \ coderd/apidoc/swagger.json \
docs/manifest.json \
site/e2e/provisionerGenerated.ts \ site/e2e/provisionerGenerated.ts \
site/src/theme/icons.json \ site/src/theme/icons.json \
examples/examples.gen.json \ examples/examples.gen.json \
@ -748,11 +754,10 @@ docs/admin/integrations/prometheus.md: node_modules/.installed scripts/metricsdo
pnpm exec markdown-table-formatter ./docs/admin/integrations/prometheus.md pnpm exec markdown-table-formatter ./docs/admin/integrations/prometheus.md
touch "$@" touch "$@"
docs/reference/cli/index.md: node_modules/.installed site/node_modules/.installed scripts/clidocgen/main.go examples/examples.gen.json $(GO_SRC_FILES) docs/reference/cli/index.md: node_modules/.installed scripts/clidocgen/main.go examples/examples.gen.json $(GO_SRC_FILES)
CI=true BASE_PATH="." go run ./scripts/clidocgen CI=true BASE_PATH="." go run ./scripts/clidocgen
pnpm exec markdownlint-cli2 --fix ./docs/reference/cli/*.md pnpm exec markdownlint-cli2 --fix ./docs/reference/cli/*.md
pnpm exec markdown-table-formatter ./docs/reference/cli/*.md pnpm exec markdown-table-formatter ./docs/reference/cli/*.md
(cd site/ && pnpm exec biome format --write ../docs/manifest.json)
touch "$@" touch "$@"
docs/admin/security/audit-logs.md: node_modules/.installed coderd/database/querier.go scripts/auditdocgen/main.go enterprise/audit/table.go coderd/rbac/object_gen.go docs/admin/security/audit-logs.md: node_modules/.installed coderd/database/querier.go scripts/auditdocgen/main.go enterprise/audit/table.go coderd/rbac/object_gen.go
@ -761,11 +766,30 @@ docs/admin/security/audit-logs.md: node_modules/.installed coderd/database/queri
pnpm exec markdown-table-formatter ./docs/admin/security/audit-logs.md pnpm exec markdown-table-formatter ./docs/admin/security/audit-logs.md
touch "$@" touch "$@"
coderd/apidoc/swagger.json: node_modules/.installed site/node_modules/.installed $(shell find ./scripts/apidocgen $(FIND_EXCLUSIONS) -type f) $(wildcard coderd/*.go) $(wildcard enterprise/coderd/*.go) $(wildcard codersdk/*.go) $(wildcard enterprise/wsproxy/wsproxysdk/*.go) $(DB_GEN_FILES) .swaggo docs/manifest.json coderd/rbac/object_gen.go coderd/apidoc/.gen: \
node_modules/.installed \
scripts/apidocgen/node_modules/.installed \
$(wildcard coderd/*.go) \
$(wildcard enterprise/coderd/*.go) \
$(wildcard codersdk/*.go) \
$(wildcard enterprise/wsproxy/wsproxysdk/*.go) \
$(DB_GEN_FILES) \
coderd/rbac/object_gen.go \
.swaggo \
scripts/apidocgen/generate.sh \
$(wildcard scripts/apidocgen/postprocess/*) \
$(wildcard scripts/apidocgen/markdown-template/*)
./scripts/apidocgen/generate.sh ./scripts/apidocgen/generate.sh
pnpm exec markdownlint-cli2 --fix ./docs/reference/api/*.md pnpm exec markdownlint-cli2 --fix ./docs/reference/api/*.md
pnpm exec markdown-table-formatter ./docs/reference/api/*.md pnpm exec markdown-table-formatter ./docs/reference/api/*.md
(cd site/ && pnpm exec biome format --write ../docs/manifest.json ../coderd/apidoc/swagger.json) touch "$@"
docs/manifest.json: site/node_modules/.installed coderd/apidoc/.gen docs/reference/cli/index.md
(cd site/ && pnpm exec biome format --write ../docs/manifest.json)
touch "$@"
coderd/apidoc/swagger.json: site/node_modules/.installed coderd/apidoc/.gen
(cd site/ && pnpm exec biome format --write ../coderd/apidoc/swagger.json)
touch "$@" touch "$@"
update-golden-files: update-golden-files:

1
scripts/apidocgen/generate.sh
View File

@ -27,7 +27,6 @@ go run github.com/swaggo/swag/cmd/swag@v1.8.9 init \
popd popd
pushd "${APIDOCGEN_DIR}" pushd "${APIDOCGEN_DIR}"
pnpm i
# Make sure that widdershins is installed correctly. # Make sure that widdershins is installed correctly.
pnpm exec -- widdershins --version pnpm exec -- widdershins --version