add job to check if docs are up to date (#473)

* add job to check if docs are up to date

Signed-off-by: cpanato <ctadeu@gmail.com>

* remove auto generated date

Signed-off-by: cpanato <ctadeu@gmail.com>

* disable auto generated tag in the docs

Signed-off-by: cpanato <ctadeu@gmail.com>

Signed-off-by: cpanato <ctadeu@gmail.com>

.github/workflows/ci.yaml

@@ -78,6 +78,27 @@ jobs:
           echo "Building snapshot..."
           ./build.sh
 
+  check-docs:
+    name: check-docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # v3
+      - uses: actions/setup-go@84cbf8094393cdc5fe1fe1671ff2647332956b1a # v3
+        with:
+          go-version-file: './go.mod'
+          check-latest: true
+
+      - name: generate docs
+        run: |
+          go build -o ct-bin ./ct/main.go
+          ./ct-bin doc-gen
+          git_status="$(git status --porcelain)"
+          if [[ ${git_status} ]]; then
+              echo -e 'Documentation is outdated. Please update the docs\n'
+              echo "${git_status}"
+              exit 1
+          fi
+
   golangci:
     name: lint
     runs-on: ubuntu-latest

.gitignore

@@ -5,3 +5,4 @@
 /dist
 /config.*
 vendor
+/ct-bin

ct/cmd/root.go

@@ -49,6 +49,8 @@ func NewRootCmd() *cobra.Command {
 	cmd.AddCommand(newVersionCmd())
 	cmd.AddCommand(newGenerateDocsCmd())
 
+	cmd.DisableAutoGenTag = true
+
 	return cmd
 }
 

doc/ct.md

@@ -26,4 +26,3 @@ in given chart directories.
 * [ct list-changed](ct_list-changed.md)	 - List changed charts
 * [ct version](ct_version.md)	 - Print version information
 
-###### Auto generated by spf13/cobra on 23-Mar-2022

doc/ct_install.md

@@ -78,4 +78,3 @@ ct install [flags]
 
 * [ct](ct.md)	 - The Helm chart testing tool
 
-###### Auto generated by spf13/cobra on 23-Mar-2022

doc/ct_lint-and-install.md

@@ -77,4 +77,3 @@ ct lint-and-install [flags]
 
 * [ct](ct.md)	 - The Helm chart testing tool
 
-###### Auto generated by spf13/cobra on 23-Mar-2022

doc/ct_lint.md

@@ -74,4 +74,3 @@ ct lint [flags]
 
 * [ct](ct.md)	 - The Helm chart testing tool
 
-###### Auto generated by spf13/cobra on 23-Mar-2022

doc/ct_list-changed.md

@@ -32,4 +32,3 @@ ct list-changed [flags]
 
 * [ct](ct.md)	 - The Helm chart testing tool
 
-###### Auto generated by spf13/cobra on 23-Mar-2022

doc/ct_version.md

@@ -16,4 +16,3 @@ ct version [flags]
 
 * [ct](ct.md)	 - The Helm chart testing tool
 
-###### Auto generated by spf13/cobra on 23-Mar-2022