update cli-docs-gen tools to remove old reference doc files

Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
docker · Nov 2, 2023 · 91f61cf · 91f61cf
1 parent 6727908
commit 91f61cf
Show file tree

Hide file tree

Showing 10 changed files with 7 additions and 239 deletions.
diff --git a/Makefile b/Makefile
@@ -116,7 +116,7 @@ lint: ## run linter(s)
 docs: ## generate documentation
 	$(eval $@_TMP_OUT := $(shell mktemp -d -t compose-output.XXXXXXXXXX))
 	$(BUILDX_CMD) bake --set "*.output=type=local,dest=$($@_TMP_OUT)" docs-update
-	rm -rf ./docs/internal
+	rm -rf ./docs/reference/*
 	cp -R "$(DRIVE_PREFIX)$($@_TMP_OUT)"/out/* ./docs/
 	rm -rf "$(DRIVE_PREFIX)$($@_TMP_OUT)"/*
 

diff --git a/docs/reference/compose_alpha.md b/docs/reference/compose_alpha.md
diff --git a/docs/reference/compose_alpha_dry-run.md b/docs/reference/compose_alpha_dry-run.md
diff --git a/docs/reference/compose_alpha_scale.md b/docs/reference/compose_alpha_scale.md
diff --git a/docs/reference/docker_compose_alpha_dry-run.yaml b/docs/reference/docker_compose_alpha_dry-run.yaml
diff --git a/docs/reference/docker_compose_alpha_scale.yaml b/docs/reference/docker_compose_alpha_scale.yaml
diff --git a/docs/reference/docker_compose_convert.yaml b/docs/reference/docker_compose_convert.yaml
diff --git a/docs/yaml/main/generate.go b/docs/yaml/main/generate.go
@@ -48,7 +48,7 @@ func generateDocs(opts *options) error {
 	if err != nil {
 		return err
 	}
-	return tool.GenAllTree()
+	return tool.GenAllTreeAndRemoveOldFiles()
 }
 
 func disableFlagsInUseLine(cmd *cobra.Command) {
@@ -77,7 +77,7 @@ func main() {
 	cwd, _ := os.Getwd()
 	opts := &options{
 		source: filepath.Join(cwd, "docs", "reference"),
-		target: filepath.Join(cwd, "docs", "reference"),
+		target: filepath.Join(cwd, "docs", "tmp"),
 	}
 	fmt.Printf("Project root: %s\n", opts.source)
 	fmt.Printf("Generating yaml files into %s\n", opts.target)

diff --git a/go.mod b/go.mod
@@ -178,3 +178,5 @@ require (
 	sigs.k8s.io/structured-merge-diff/v4 v4.2.3 // indirect
 	sigs.k8s.io/yaml v1.3.0 // indirect
 )
+
+replace github.com/docker/cli-docs-tool v0.6.0 => github.com/glours/cli-docs-tool v0.6.1-0.20231102180605-fea6905ab3d0
diff --git a/go.sum b/go.sum
@@ -177,8 +177,6 @@ github.com/docker/buildx v0.11.2 h1:R3p9F0gnI4FwvQ0p40UwdX1T4ugap4UWxY3TFHoP4Ws=
 github.com/docker/buildx v0.11.2/go.mod h1:CWAABt10iIuGpleypA3103mplDfcGu0A2AvT03xfpTc=
 github.com/docker/cli v24.0.6+incompatible h1:fF+XCQCgJjjQNIMjzaSmiKJSCcfcXb3TWTcc7GAneOY=
 github.com/docker/cli v24.0.6+incompatible/go.mod h1:JLrzqnKDaYBop7H2jaqPtU4hHvMKP+vjCwu2uszcLI8=
-github.com/docker/cli-docs-tool v0.6.0 h1:Z9x10SaZgFaB6jHgz3OWooynhSa40CsWkpe5hEnG/qA=
-github.com/docker/cli-docs-tool v0.6.0/go.mod h1:zMjqTFCU361PRh8apiXzeAZ1Q/xupbIwTusYpzCXS/o=
 github.com/docker/distribution v2.7.1+incompatible/go.mod h1:J2gT2udsDAN96Uj4KfcMRqY0/ypR+oyYUYmja8H+y+w=
 github.com/docker/distribution v2.8.2+incompatible h1:T3de5rq0dB1j30rp0sA2rER+m322EBzniBPB6ZIzuh8=
 github.com/docker/distribution v2.8.2+incompatible/go.mod h1:J2gT2udsDAN96Uj4KfcMRqY0/ypR+oyYUYmja8H+y+w=
@@ -226,6 +224,8 @@ github.com/fsnotify/fsnotify v1.6.0/go.mod h1:sl3t1tCWJFWoRz9R8WJCbQihKKwmorjAbS
 github.com/fvbommel/sortorder v1.0.2 h1:mV4o8B2hKboCdkJm+a7uX/SIpZob4JzUpc5GGnM45eo=
 github.com/fvbommel/sortorder v1.0.2/go.mod h1:uk88iVf1ovNn1iLfgUVU2F9o5eO30ui720w+kxuqRs0=
 github.com/ghodss/yaml v1.0.0/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04=
+github.com/glours/cli-docs-tool v0.6.1-0.20231102180605-fea6905ab3d0 h1:qvqOkwG1Er7Ev9x4ymZWh51Ab5LeQdqUEmPnzYhi/Gw=
+github.com/glours/cli-docs-tool v0.6.1-0.20231102180605-fea6905ab3d0/go.mod h1:zMjqTFCU361PRh8apiXzeAZ1Q/xupbIwTusYpzCXS/o=
 github.com/go-gl/glfw v0.0.0-20190409004039-e6da0acd62b1/go.mod h1:vR7hzQXu2zJy9AVAgeJqvqgH9Q5CA+iKCZ2gyEVpxRU=
 github.com/go-gl/glfw/v3.3/glfw v0.0.0-20191125211704-12ad95a8df72/go.mod h1:tQ2UAYgL5IevRw8kRxooKSPJfGvJ9fJQFa0TUsXzTg8=
 github.com/go-gl/glfw/v3.3/glfw v0.0.0-20200222043503-6f7a984d4dc4/go.mod h1:tQ2UAYgL5IevRw8kRxooKSPJfGvJ9fJQFa0TUsXzTg8=