You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Before unifying the pipelines or adding a freshness check, #1175 needs to be resolved. make generate-crdocs uses crdoc --output which completely overwrites each docs file, destroying any hand-written content. Until that's fixed, we can't safely run make codegen as part of make prep or CI.
Problem
The repo has two independent generation pipelines that don't cover each other's outputs:
make codegenmake prepbuild-quickstart)docs/*.mdinstall.yamlThis means:
install.yamldrifts because onlymake prepregenerates itdocs/*.mddrift because onlymake codegenregenerates themCurrent state on master
Running
make codegenon master today produces diffs in:docs/programs.md— clobbers hand-written Package Management section (see codegen: make generate-crdocs clobbers hand-written content in docs/programs.md #1175)docs/workspaces.md— adds missing GitHub App auth docs that feat: add GitHub App authentication for git sources #1167 should have generatedRunning
make prepproduces additional diffs in:deploy/quickstart/install.yaml— picks up CRD changes from feat: add --run-program support for destroy and refresh #1171 and docs: clarify ResyncFrequencySeconds and ContinueResyncOnCommitMatch #1176 that were never regeneratedRecent examples
docs/programs.mdby runningmake codegeninstall.yamldocs/workspaces.mdBlockers
Before unifying the pipelines or adding a freshness check, #1175 needs to be resolved.
make generate-crdocsusescrdoc --outputwhich completely overwrites each docs file, destroying any hand-written content. Until that's fixed, we can't safely runmake codegenas part ofmake prepor CI.Suggested plan
crdocfrom clobbering hand-written docs content)make codegenalso runmake build-deploy(or add a unifiedmake generate-all)make generate-all && git diff --exit-code