feat(docs,ci): add docs generation and PR checks

Author: ndbaker1

.github/workflows/ci-pr.yaml

@@ -0,0 +1,15 @@
+name: "[CI] PR"
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+jobs:
+  check-generate:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # 4.2.2
+    - run: |
+        go install github.com/norwoodj/helm-docs/cmd/helm-docs@37d3055fece566105cf8cff7c17b7b2355a01677
+    - run: hack/check-generate.sh

.github/workflows/dependency-review.yaml

@@ -0,0 +1,13 @@
+name: "Dependency Review"
+on:
+  pull_request:
+    branches:
+      - "main"
+permissions:
+  contents: read
+jobs:
+  dependency-review:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # 4.2.2
+      - uses: actions/dependency-review-action@3b139cfc5fae8b618d3eae3675e383bb1769c019 # 4.5.0

Makefile

@@ -0,0 +1,5 @@
+.PHONY: helm-docs
+helm-docs:
+	hack/helm-docs.sh charts/eks-node-monitoring-agent/README.md
+
+generate: helm-docs

charts/eks-node-monitoring-agent/README.md

@@ -25,9 +25,10 @@ helm uninstall eks-node-monitoring-agent --namespace kube-system
 
 The following table lists the configurable parameters for this chart and their default values.
 
+<!-- table:start -->
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
-| dcgmAgent.affinity | object | (see [`values.yaml`](./values.yaml)) | Map of dcgm pod affinities |
+| dcgmAgent.affinity | object | see [`values.yaml`](./values.yaml) | Map of dcgm pod affinities |
 | dcgmAgent.image.account | string | `"602401143452"` | ECR repository account number for the dcgm-exporter |
 | dcgmAgent.image.domain | string | `"amazonaws.com"` | ECR repository domain for the dcgm-exporter |
 | dcgmAgent.image.endpoint | string | `"ecr"` | ECR repository endpoint for the dcgm-exporter |
@@ -39,17 +40,18 @@ The following table lists the configurable parameters for this chart and their d
 | imagePullSecrets | list | `[]` | Docker registry pull secrets |
 | nameOverride | string | `"eks-node-monitoring-agent"` | A name override for the chart |
 | nodeAgent.additionalArgs | list | `[]` | List of addittional container arguments for the eks-node-monitoring-agent |
-| nodeAgent.affinity | object | (see [`values.yaml`](./values.yaml)) | Map of pod affinities for the eks-node-monitoring-agent |
+| nodeAgent.affinity | object | see [`values.yaml`](./values.yaml) | Map of pod affinities for the eks-node-monitoring-agent |
 | nodeAgent.image.account | string | `"602401143452"` | ECR repository account number for the eks-node-monitoring-agent |
 | nodeAgent.image.domain | string | `"amazonaws.com"` | ECR repository domain for the eks-node-monitoring-agent |
 | nodeAgent.image.endpoint | string | `"ecr"` | ECR repository endpoint for the eks-node-monitoring-agent |
 | nodeAgent.image.pullPolicy | string | `"IfNotPresent"` | Container pull policyfor the eks-node-monitoring-agent |
 | nodeAgent.image.region | string | `"us-west-2"` | ECR repository region for the eks-node-monitoring-agent |
-| nodeAgent.image.tag | string | `"v1.0.2-eksbuild.2"` | Image tag for the eks-node-monitoring-agent |
+| nodeAgent.image.tag | string | `"v1.1.0-eksbuild.1"` | Image tag for the eks-node-monitoring-agent |
 | nodeAgent.resources | object | `{"limits":{"cpu":"250m","memory":"100Mi"},"requests":{"cpu":"10m","memory":"30Mi"}}` | Container resources for the eks-node-monitoring-agent |
 | nodeAgent.securityContext | object | `{"capabilities":{"add":["NET_ADMIN"]},"privileged":true}` | Container Security context for the eks-node-monitoring-agent |
 | nodeAgent.tolerations | list | `[{"operator":"Exists"}]` | Deployment tolerations for the eks-node-monitoring-agent |
 | updateStrategy | object | `{"rollingUpdate":{"maxUnavailable":"10%"},"type":"RollingUpdate"}` | Update strategy for all daemon sets |
+<!-- table:end -->
 
 Specify each parameter using the `--set key=value[,key=value]` argument to `helm install` or provide a YAML file
 containing the values for the above parameters.

charts/eks-node-monitoring-agent/values.yaml

@@ -20,7 +20,7 @@ serviceAccount:
 nodeAgent:
   image:
     # -- Image tag for the eks-node-monitoring-agent
-    tag: v1.0.2-eksbuild.2
+    tag: v1.1.0-eksbuild.1
     # -- ECR repository domain for the eks-node-monitoring-agent
     domain: amazonaws.com
     # -- ECR repository region for the eks-node-monitoring-agent

hack/check-generate.sh

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+make generate
+if ! git diff --exit-code .; then
+    echo >&2 "ERROR: generated code is out of date. Please run 'make generate' and commit the changes."
+    exit 1
+fi

hack/helm-docs.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+set -o nounset
+set -o errexit
+set -o pipefail
+
+README_PATH=$1
+
+template() {
+    sed '0,/<!-- table:start -->/!d' $README_PATH;
+    helm-docs --dry-run --ignore-non-descriptions 2>/dev/null | sed -e 's#`.\{100,\}`#see [`values.yaml`](./values.yaml)#g' | tail -n +15 | head -n -1;
+    tac $README_PATH | sed '0,/<!-- table:end -->/!d' | tac;
+}
+
+template > $README_PATH.tmp
+mv $README_PATH.tmp $README_PATH