chore(docs): added makefile target

Signed-off-by: ivan katliarchuk <[email protected]>
kubernetes-sigs · Dec 31, 2024 · 956510a · 956510a
1 parent fd150ef
commit 956510a
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 3 deletions.
diff --git a/Makefile b/Makefile
@@ -160,3 +160,8 @@ release.prod: test
 .PHONY: ko
 ko:
 	scripts/install-ko.sh
+
+# generate-documentation: Generate documentation (docs/flags.md)
+.PHONE: generate-docs
+generate-documentation:
+	go run internal/gen/main.go
diff --git a/docs/flags.md b/docs/flags.md
@@ -1,7 +1,7 @@
 # Flags
 
 <!-- THIS FILE MUST NOT BE EDITED BY HAND -->
-<!-- ON NEW FLAG ADDED PLEASE RUN 'go run internal/gen/main.go' -->
+<!-- ON NEW FLAG ADDED PLEASE RUN 'make generate-documentation' -->
 
 | Flag | Description  |
 | :------ | :----------- |

diff --git a/internal/gen/main.go b/internal/gen/main.go
@@ -40,7 +40,7 @@ func (f *Flags) AddFlag(name, description string) {
 const markdownTemplate = `# Flags
 
 <!-- THIS FILE MUST NOT BE EDITED BY HAND -->
-<!-- ON NEW FLAG ADDED PLEASE RUN 'go run internal/gen/main.go' -->
+<!-- ON NEW FLAG ADDED PLEASE RUN 'make generate-documentation' -->
 
 | Flag | Description  |
 | :------ | :----------- |

diff --git a/internal/gen/main_test.go b/internal/gen/main_test.go
@@ -71,7 +71,7 @@ func TestFlagsMdUpToDate(t *testing.T) {
 	actual, err := flags.generateMarkdownTable()
 	assert.NoError(t, err)
 
-	assert.True(t, len(expected) == len(actual), "expected file '%s' to be up to date. execute 'go run internal/gen/main.g", filePath)
+	assert.True(t, len(expected) == len(actual), "expected file '%s' to be up to date. execute 'make generate-documentation", filePath)
 }
 
 func TestFlagsMdExtraFlagAdded(t *testing.T) {