chore(docs): automatic generate pipeline docs

This commit adds a make target to generate documentation for pipelines. It also makes it run during the verify github workflow, alongside the generation of documentation of melange itself. Signed-off-by: Massimiliano Giovagnoli <[email protected]>
chainguard-dev · Dec 12, 2024 · f5b0d75 · f5b0d75
1 parent fa53d52
commit f5b0d75
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/.github/workflows/verify.yaml b/.github/workflows/verify.yaml
@@ -34,6 +34,7 @@ jobs:
 
       - run: |
           make docs-repo
+          make docs-pipeline
           git diff --exit-code
 
       - run: |

diff --git a/Makefile b/Makefile
@@ -202,6 +202,15 @@ docs:
 docs-repo:
 	go run docs/main.go --baseurl /docs/md/ --suffix .md --out docs/md
 
+##################
+# docs-pipeline - This creates documents for pipelines.
+##################
+.PHONY: docs-pipeline
+docs-pipeline:
+	@pushd pkg/build/pipelines >/dev/null && \
+		go run ../../../docs/cmd/pipeline-reference-gen/main.go --pipeline-dir . && \
+		popd >/dev/null
+
 ##################
 # help
 ##################
-Original file line number
+Diff line change
@@ Expand Up / @@ -34,6 +34,7 @@ jobs: @@
           - run: |
               make docs-repo
+              make docs-pipeline
               git diff --exit-code
           - run: |
@@ Expand Down @@