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

cpanato · web-flow · commit f554590e9ad0 · 2022-09-19T13:13:20.000+02:00
* add job to check if docs are up to date

Signed-off-by: cpanato &lt;ctadeu@gmail.com&gt;

* remove auto generated date

Signed-off-by: cpanato &lt;ctadeu@gmail.com&gt;

* disable auto generated tag in the docs

Signed-off-by: cpanato &lt;ctadeu@gmail.com&gt;

Signed-off-by: cpanato &lt;ctadeu@gmail.com&gt;
diff --git a/.github/workflows/ci.yaml b/.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
diff --git a/.gitignore b/.gitignore
@@ -5,3 +5,4 @@
 /dist
 /config.*
 vendor
+/ct-bin
diff --git a/ct/cmd/root.go b/ct/cmd/root.go
@@ -49,6 +49,8 @@ func NewRootCmd() *cobra.Command {
 	cmd.AddCommand(newVersionCmd())
 	cmd.AddCommand(newGenerateDocsCmd())
 
+	cmd.DisableAutoGenTag = true
+
 	return cmd
 }
 
diff --git a/doc/ct.md b/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
diff --git a/doc/ct_install.md b/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
diff --git a/doc/ct_lint-and-install.md b/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
diff --git a/doc/ct_lint.md b/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
diff --git a/doc/ct_list-changed.md b/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
diff --git a/doc/ct_version.md b/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

-Original file line number
+Diff line change
 /dist
 /config.*
 vendor
 +/ct-bin
Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,8 @@ func NewRootCmd() *cobra.Command {`
`49`	`49`	`cmd.AddCommand(newVersionCmd())`
`50`	`50`	`cmd.AddCommand(newGenerateDocsCmd())`
`51`	`51`
	`52`	`+ cmd.DisableAutoGenTag = true`
	`53`	`+`
`52`	`54`	`return cmd`
`53`	`55`	`}`
`54`	`56`
Original file line number	Diff line number	Diff line change
`@@ -26,4 +26,3 @@ in given chart directories.`
`26`	`26`	`* [ct list-changed](ct_list-changed.md) - List changed charts`
`27`	`27`	`* [ct version](ct_version.md) - Print version information`
`28`	`28`
`29`		`-###### Auto generated by spf13/cobra on 23-Mar-2022`
Original file line number	Diff line number	Diff line change
`@@ -78,4 +78,3 @@ ct install [flags]`
`78`	`78`
`79`	`79`	`* [ct](ct.md) - The Helm chart testing tool`
`80`	`80`
`81`		`-###### Auto generated by spf13/cobra on 23-Mar-2022`
Original file line number	Diff line number	Diff line change
`@@ -77,4 +77,3 @@ ct lint-and-install [flags]`
`77`	`77`
`78`	`78`	`* [ct](ct.md) - The Helm chart testing tool`
`79`	`79`
`80`		`-###### Auto generated by spf13/cobra on 23-Mar-2022`
Original file line number	Diff line number	Diff line change
`@@ -74,4 +74,3 @@ ct lint [flags]`
`74`	`74`
`75`	`75`	`* [ct](ct.md) - The Helm chart testing tool`
`76`	`76`
`77`		`-###### Auto generated by spf13/cobra on 23-Mar-2022`
Original file line number	Diff line number	Diff line change
`@@ -32,4 +32,3 @@ ct list-changed [flags]`
`32`	`32`
`33`	`33`	`* [ct](ct.md) - The Helm chart testing tool`
`34`	`34`
`35`		`-###### Auto generated by spf13/cobra on 23-Mar-2022`
Original file line number	Diff line number	Diff line change
`@@ -16,4 +16,3 @@ ct version [flags]`
`16`	`16`
`17`	`17`	`* [ct](ct.md) - The Helm chart testing tool`
`18`	`18`
`19`		`-###### Auto generated by spf13/cobra on 23-Mar-2022`