Multiple Changes

- Add .gitignore for bin - Move docs verify script to scripts/ and update workflow - Update Makefile to point to main.go in repo root - Remove auto generated by cobra message Signed-off-by: Aditya Sirish <aditya@saky.in>
in-toto · Oct 9, 2021 · 9685077 · 9685077
1 parent d9ba4ac
commit 9685077
Show file tree

Hide file tree

Showing 17 changed files with 10 additions and 20 deletions.
diff --git a/.github/workflows/verify-docgen.yml b/.github/workflows/verify-docgen.yml
@@ -16,4 +16,4 @@ jobs:
       - uses: actions/setup-go@v2
         with:
           go-version: '1.17.x'
-      - run: ./cmd/verify.sh
+      - run: ./scripts/verify-docs.sh
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+bin/
diff --git a/Makefile b/Makefile
@@ -14,7 +14,7 @@ LAYOUT_TMPL := ./certs/layout.tmpl
 
 build: modules
 	@mkdir -p bin
-	@go build -o ./bin/in-toto ./cmd
+	@go build -o ./bin/in-toto main.go
 
 modules:
 	@go mod tidy

diff --git a/cmd/root.go b/cmd/root.go
@@ -20,11 +20,12 @@ var (
 )
 
 var rootCmd = &cobra.Command{
-	Use:           "in-toto",
-	Short:         "Framework to secure integrity of software supply chains",
-	Long:          `A framework to secure the integrity of software supply chains https://in-toto.io/`,
-	SilenceUsage:  true,
-	SilenceErrors: true,
+	Use:               "in-toto",
+	Short:             "Framework to secure integrity of software supply chains",
+	Long:              `A framework to secure the integrity of software supply chains https://in-toto.io/`,
+	SilenceUsage:      true,
+	SilenceErrors:     true,
+	DisableAutoGenTag: true,
 }
 
 // Execute runs the root command

diff --git a/doc/in-toto.md b/doc/in-toto.md
@@ -23,4 +23,3 @@ A framework to secure the integrity of software supply chains https://in-toto.io
 * [in-toto sign](in-toto_sign.md)	 - Provides command line interface to sign in-toto link or layout metadata
 * [in-toto verify](in-toto_verify.md)	 - Verify that the software supply chain of the delivered product
 
-###### Auto generated by spf13/cobra on 4-Oct-2021
diff --git a/doc/in-toto_completion.md b/doc/in-toto_completion.md
@@ -44,4 +44,3 @@ in-toto completion [bash|zsh|fish|powershell]
 
 * [in-toto](in-toto.md)	 - Framework to secure integrity of software supply chains
 
-###### Auto generated by spf13/cobra on 4-Oct-2021
diff --git a/doc/in-toto_gendoc.md b/doc/in-toto_gendoc.md
@@ -17,4 +17,3 @@ in-toto gendoc [flags]
 
 * [in-toto](in-toto.md)	 - Framework to secure integrity of software supply chains
 
-###### Auto generated by spf13/cobra on 4-Oct-2021
diff --git a/doc/in-toto_key.md b/doc/in-toto_key.md
@@ -14,4 +14,3 @@ Key management commands
 * [in-toto key id](in-toto_key_id.md)	 - Output the key id for a given key
 * [in-toto key layout](in-toto_key_layout.md)	 - Output the key layout for a given key in <KEYID>: <KEYOBJ> format
 
-###### Auto generated by spf13/cobra on 4-Oct-2021
diff --git a/doc/in-toto_key_id.md b/doc/in-toto_key_id.md
@@ -20,4 +20,3 @@ in-toto key id <file> [flags]
 
 * [in-toto key](in-toto_key.md)	 - Key management commands
 
-###### Auto generated by spf13/cobra on 4-Oct-2021
diff --git a/doc/in-toto_key_layout.md b/doc/in-toto_key_layout.md
@@ -20,4 +20,3 @@ in-toto key layout <file> [flags]
 
 * [in-toto key](in-toto_key.md)	 - Key management commands
 
-###### Auto generated by spf13/cobra on 4-Oct-2021
diff --git a/doc/in-toto_record.md b/doc/in-toto_record.md
@@ -42,4 +42,3 @@ failure and zero otherwise.
 passed materials and signs it with the passed functionary’s key.
 * [in-toto record stop](in-toto_record_stop.md)	 - Records and adds the paths and hashes of the passed products to the link metadata file and updates the signature.
 
-###### Auto generated by spf13/cobra on 4-Oct-2021
diff --git a/doc/in-toto_record_start.md b/doc/in-toto_record_start.md
@@ -51,4 +51,3 @@ in-toto record start [flags]
 * [in-toto record](in-toto_record.md)	 - Creates a signed link metadata file in two steps, in order to provide
               evidence for supply chain steps that cannot be carried out by a single command
 
-###### Auto generated by spf13/cobra on 4-Oct-2021
diff --git a/doc/in-toto_record_stop.md b/doc/in-toto_record_stop.md
@@ -52,4 +52,3 @@ in-toto record stop [flags]
 * [in-toto record](in-toto_record.md)	 - Creates a signed link metadata file in two steps, in order to provide
               evidence for supply chain steps that cannot be carried out by a single command
 
-###### Auto generated by spf13/cobra on 4-Oct-2021
diff --git a/doc/in-toto_run.md b/doc/in-toto_run.md
@@ -50,4 +50,3 @@ in-toto run [flags]
 
 * [in-toto](in-toto.md)	 - Framework to secure integrity of software supply chains
 
-###### Auto generated by spf13/cobra on 4-Oct-2021
diff --git a/doc/in-toto_sign.md b/doc/in-toto_sign.md
@@ -25,4 +25,3 @@ in-toto sign [flags]
 
 * [in-toto](in-toto.md)	 - Framework to secure integrity of software supply chains
 
-###### Auto generated by spf13/cobra on 4-Oct-2021
diff --git a/doc/in-toto_verify.md b/doc/in-toto_verify.md
@@ -35,4 +35,3 @@ in-toto verify [flags]
 
 * [in-toto](in-toto.md)	 - Framework to secure integrity of software supply chains
 
-###### Auto generated by spf13/cobra on 4-Oct-2021
diff --git a/cmd/verify.sh → scripts/verify-docs.sh b/cmd/verify.sh → scripts/verify-docs.sh
@@ -4,7 +4,7 @@ set -e
 
 # Verify that generated Markdown docs are up-to-date.
 tmpdir=$(mktemp -d)
-go run ./cmd gendoc --dir "$tmpdir"
+go run main.go gendoc --dir "$tmpdir"
 echo "###########################################"
 echo "If diffs are found, run: go run ./cmd gendoc"
 echo "###########################################"