From d28722a5a9c48ac1754f3021fd20484ec0da7f28 Mon Sep 17 00:00:00 2001 From: Alex Collins Date: Wed, 5 Aug 2020 17:37:43 -0700 Subject: [PATCH 1/3] chore: Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 62 ++++--------------- .../ISSUE_TEMPLATE/enhancement_proposal.md | 14 ++--- 2 files changed, 16 insertions(+), 60 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index e6fb63fcf086..fe610d87a6f7 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,68 +1,30 @@ --- name: Bug report about: Create a report to help us improve -title: '' labels: 'bug' -assignees: '' --- -Checklist: +## Summary - * [ ] I've included the version. - * [ ] I've included reproduction steps. - * [ ] I've included the workflow YAML. - * [ ] I've included the logs. - -**What happened**: +What happened/what you expected to happen? -**What you expected to happen**: +## Diagnostics -**How to reproduce it (as minimally and precisely as possible)**: +What version of Argo Workflows are you running? -**Anything else we need to know?**: - -**Environment**: - -- Argo version: -``` -$ argo version -``` -- Kubernetes version : -``` -$ kubectl version -o yaml -``` - -**Other debugging information (if applicable)**: - -- workflow result: - -``` -argo --loglevel DEBUG get +```yaml +Paste here either: + A workflow anyone can run that reproduces your bug (tip: we can't run private images). +Or: + The whole workflow here, including status, e.g. kubectl get wf ${workflow} ``` -- executor logs: - -``` -kubectl logs -c init -kubectl logs -c wait -``` - -- workflow-controller logs: - -``` -kubectl logs -n argo $(kubectl get pods -l app=workflow-controller -n argo -o name) -``` - -**Logs** - ``` -argo get -kubectl logs -c init -kubectl logs -c wait -kubectl logs -n argo $(kubectl get pods -l app=workflow-controller -n argo -o name) +Paste the logs from the workflow controller: +kubectl logs -n argo $(kubectl get pods -l app=workflow-controller -n argo -o name) | grep ${workflow} ``` --- **Message from the maintainers**: -If you are impacted by this bug please add a 👍 reaction to this issue! We often sort issues this way to know what to prioritize. +Impacted by this bug? Give it a 👍. We prioritise the issues with the most 👍. diff --git a/.github/ISSUE_TEMPLATE/enhancement_proposal.md b/.github/ISSUE_TEMPLATE/enhancement_proposal.md index 1807d6010d36..a20e71ec24c1 100644 --- a/.github/ISSUE_TEMPLATE/enhancement_proposal.md +++ b/.github/ISSUE_TEMPLATE/enhancement_proposal.md @@ -1,24 +1,18 @@ --- name: Enhancement proposal about: Propose an enhancement for this project -title: '' labels: 'enhancement' -assignees: '' --- # Summary -What change you think needs making. +What change needs making? -# Motivation +# Use Cases -Please give examples of your use case, e.g. when would you use this. - -# Proposal - -How do you think this should be implemented? +When would you use this? --- **Message from the maintainers**: -If you wish to see this enhancement implemented please add a 👍 reaction to this issue! We often sort issues this way to know what to prioritize. +Impacted by this bug? Give it a 👍. We prioritise the issues with the most 👍. \ No newline at end of file From f0ec777ee6731ce5223c97006aa34cb86262eee4 Mon Sep 17 00:00:00 2001 From: Alex Collins Date: Wed, 5 Aug 2020 17:40:28 -0700 Subject: [PATCH 2/3] issue-templates --- .github/ISSUE_TEMPLATE/bug_report.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index fe610d87a6f7..a2caba32ffe4 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -11,6 +11,8 @@ What happened/what you expected to happen? What version of Argo Workflows are you running? +Paste a screenshot of your workflow. + ```yaml Paste here either: A workflow anyone can run that reproduces your bug (tip: we can't run private images). From 6ac050fc3ae813e5a92c2a518d06e0fe4f8837c6 Mon Sep 17 00:00:00 2001 From: Jesse Suen Date: Thu, 6 Aug 2020 12:29:29 -0700 Subject: [PATCH 3/3] Update bug_report.md --- .github/ISSUE_TEMPLATE/bug_report.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index a2caba32ffe4..77c654fc4160 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -11,13 +11,9 @@ What happened/what you expected to happen? What version of Argo Workflows are you running? -Paste a screenshot of your workflow. - ```yaml -Paste here either: - A workflow anyone can run that reproduces your bug (tip: we can't run private images). -Or: - The whole workflow here, including status, e.g. kubectl get wf ${workflow} +Paste the workflow here, including status: +kubectl get wf -o yaml ${workflow} ``` ```