Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add action to generate CRD md documentation from yaml #4

Merged
merged 1 commit into from
Sep 23, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions generate-crd-docs/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
FROM golang:1.17-bullseye


RUN apt-get update && apt-get install -y git curl apt-transport-https
RUN curl https://baltocdn.com/helm/signing.asc | apt-key add - && \
echo "deb https://baltocdn.com/helm/stable/debian/ all main" | tee /etc/apt/sources.list.d/helm-stable-debian.list && \
apt-get update && \
apt-get install -y helm
RUN go install fybrik.io/[email protected]

WORKDIR /action

CMD crdoc --resources ${RESOURCES} --output ${OUTPUT}
4 changes: 4 additions & 0 deletions generate-crd-docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Generate CRD documentation

A simple docker action that generates a markdown documentation from a CRD yaml.
Uses [crdoc](https://github.com/fybrik/crdoc).
8 changes: 8 additions & 0 deletions generate-crd-docs/action.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
name: "generate-crd-docs"
description: "Generate Markdown documentation from CRDs. Uses https://github.com/fybrik/crdoc."
runs:
using: "docker"
image: "Dockerfile"
branding:
icon: "activity"
color: "blue"