feat: Implement get debug-info command

Implements a utility command used to generate reports containing information regarding the current project, OS and providers. It generates a zip file which can be attached to Github issues. Co-authored-by: Thorarinn Sigurdsson <[email protected]> Co-authored-by: Eyþór Magnússon <[email protected]>
garden-io · May 29, 2019 · 44f666e · 44f666e
1 parent 4c00369
commit 44f666e
Show file tree

Hide file tree

Showing 18 changed files with 1,212 additions and 745 deletions.
diff --git a/.gitignore b/.gitignore
@@ -30,3 +30,6 @@ gulpfile.js
 *.tgz
 build/
 garden-service/static/dashboard/
+
+#debug files
+debug-info-*
diff --git a/docs/reference/commands.md b/docs/reference/commands.md
@@ -324,6 +324,25 @@ Outputs the latest execution result of a provided test.
   | `module` | Yes | Module name of where the test runs.
   | `name` | Yes | Test name.
 
+### garden get debug-info
+
+Outputs the status of your environment for debug purposes.
+
+Examples:
+
+garden get debug-info                # create a zip file on the root of the project with debug information
+garden get debug-info --format yaml  # outputs the provider info as yaml files (default as json)
+
+##### Usage
+
+    garden get debug-info [options]
+
+##### Options
+
+| Argument | Alias | Type | Description |
+| -------- | ----- | ---- | ----------- |
+  | `--format` |  | `json` `yaml`  | The output format for plugin-generated debug info.
+
 ### garden init
 
 Initialize system, environment or other runtime components.