feat(command): add warning not to push secrets to the public

budimanjojo · Feb 2, 2023 · b80ac08 · b80ac08
1 parent 629e97a
commit b80ac08
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -58,6 +58,14 @@ Any input and suggestion will be highly appreciated.
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
+## WARNING
+
+**Please don't push the generated files into your public git repository.
+By default `talhelper` will create a `.gitignore` file to ignore the generated files for you unless you use `--no-gitignore` flag.
+The generated files contain unencrypted secrets and you don't want people to get a hand of them.**
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
 ## Getting Started
 
 Scenario 1 (You already have your talos config but not GitOps it yet):

diff --git a/cmd/root.go b/cmd/root.go
@@ -36,6 +36,10 @@ Workflow:
   > talhelper genconfig
 
   The generated yaml files will be in ./clusterconfig directory
+
+  WARNING! Please don't push the generated files into your public git repository.
+  By default talhelper will create a ".gitignore" file to ignore the generated files for you unless you use "--no-gitignore" flag.
+  The generated files contain unencrypted secrets and you don't want people to get a hand of them.
 `)
 
 var rootCmd = &cobra.Command{