docs: Update bug/regression templates to reduce/improve reports (argo…

…proj#9528) Signed-off-by: Alex Collins <[email protected]> Signed-off-by: Alex Collins <[email protected]>
alexec · Sep 6, 2022 · 83501a4 · 83501a4
1 parent ef6bd57
commit 83501a4
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 19 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,5 +1,5 @@
 ---
-name: Reproducible bug report 
+name: Reproducible bug report
 about: Create a reproducible bug report. Not for support requests.
 labels: ['bug']
 ---
@@ -12,7 +12,9 @@ labels: ['bug']
 
 * [ ] Double-checked my configuration.
 * [ ] Tested using `:latest` images.
-* [ ] Used the Emissary executor.
+* [ ] Attached the smallest workflow that reproduces the issue.
+* [ ] Attached logs from the workflow controller.
+* [ ] Attached logs from the wait container.
 
 ## Summary
 
@@ -28,15 +30,12 @@ Paste the smallest workflow that reproduces the bug. We must be able to run the
 
 ```
 
-```bash
+```
 # Logs from the workflow controller:
 kubectl logs -n argo deploy/workflow-controller | grep ${workflow} 
+```
 
-# If the workflow's pods have not been created, you can skip the rest of the diagnostics.
-
-# The workflow's pods that are problematic:
-kubectl get pod -o yaml -l workflows.argoproj.io/workflow=${workflow},workflow.argoproj.io/phase!=Succeeded
-
+```
 # Logs from in your workflow's wait container, something like:
 kubectl logs -c wait -l workflows.argoproj.io/workflow=${workflow},workflow.argoproj.io/phase!=Succeeded
 ```

diff --git a/.github/ISSUE_TEMPLATE/regression.md b/.github/ISSUE_TEMPLATE/regression.md
@@ -1,23 +1,24 @@
 ---
 name: Regression report
 about: Create a regression report. Not for support requests.
-labels: ['bug', 'regression', 'triage']
+labels: ['bug', 'regression']
 ---
 ## Checklist
 
 <!-- Do NOT open an issue until you have: --> 
 
 * [ ] Double-checked my configuration.
-* [ ] Tested using the latest version.
-* [ ] Used the Emissary executor.
+* [ ] Tested using `:latest` images.
+* [ ] Attached the smallest workflow that reproduces the issue.
+* [ ] Attached logs from the workflow controller.
+* [ ] Attached logs from the wait container.
 
 ## Summary
 
 What happened/what you expected to happen?
 
 What version are you running?
 
-
 ## Diagnostics
 
 Paste the smallest workflow that reproduces the bug. We must be able to run the workflow.
@@ -26,15 +27,12 @@ Paste the smallest workflow that reproduces the bug. We must be able to run the
 
 ```
 
-```bash
+```
 # Logs from the workflow controller:
-kubectl logs -n argo deploy/workflow-controller | grep ${workflow}
-
-# If the workflow's pods have not been created, you can skip the rest of the diagnostics.
-
-# The workflow's pods that are problematic:
-kubectl get pod -o yaml -l workflows.argoproj.io/workflow=${workflow},workflow.argoproj.io/phase!=Succeeded
+kubectl logs -n argo deploy/workflow-controller | grep ${workflow} 
+```
 
+```
 # Logs from in your workflow's wait container, something like:
 kubectl logs -c wait -l workflows.argoproj.io/workflow=${workflow},workflow.argoproj.io/phase!=Succeeded
 ```