From 4c18f02582b67c69d7fa1e1314a961c3db5a395d Mon Sep 17 00:00:00 2001 From: Massimiliano Giovagnoli Date: Thu, 12 Dec 2024 18:30:07 +0100 Subject: [PATCH] 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 --- .github/workflows/verify.yaml | 1 + Makefile | 8 ++++++++ 2 files changed, 9 insertions(+) diff --git a/.github/workflows/verify.yaml b/.github/workflows/verify.yaml index 6b303cc65..cb4ee2de0 100644 --- 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 index 1a01ea5b9..5fe78df23 100644 --- a/Makefile +++ b/Makefile @@ -202,6 +202,14 @@ 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: + @cd pkg/build/pipelines && \ + go run ../../../docs/cmd/pipeline-reference-gen/main.go --pipeline-dir . + ################## # help ##################