Skip to content

Commit

Permalink
docs: updated issue templates
Browse files Browse the repository at this point in the history
Signed-off-by: Alex Collins <[email protected]>
  • Loading branch information
alexec committed Sep 21, 2021
1 parent 3d0f5f5 commit 63aecdb
Show file tree
Hide file tree
Showing 3 changed files with 55 additions and 86 deletions.
28 changes: 14 additions & 14 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,35 +3,35 @@ name: Reproducible bug report
about: Create a reproducible bug report. Not for support requests.
labels: ['bug', 'triage']
---
## Summary

What happened/what you expected to happen?

<!--
Before we start, around 2/3 of issues can be fixed by one of the following:
* Have you double-checked your configuration? Maybe 30% of issues are wrong configuration.
* Have you tested to see if it is fixed in the latest version? Maybe 20% of issues are fixed by this.
* Have you tried using the PNS executor instead of Docker? Maybe 50% of artifact related issues are fixed by this.
## Diagnostics
If this is a regression, please open a regression report instead.
-->

👀 Yes! We need all of your diagnostics, please make sure you add it all, otherwise we'll go around in circles asking
you for it:
## Summary

What Kubernetes provider are you using?
What happened/what you expected to happen?

What version of Argo Workflows are you running?

What executor are you running? Docker/K8SAPI/Kubelet/PNS/Emissary

Which version was it working in?
## Diagnostics

Are you pasting thousands of log lines? That's too much information.
Either a workflow that reproduces the bug, or paste you whole workflow YAML, including status, something like:

```bash
# Either a workflow that reproduces the bug, or paste you whole workflow YAML, including status, something like:
```yaml
kubectl get wf -o yaml ${workflow}
```

What Kubernetes provider are you using?

What executor are you running? Docker/K8SAPI/Kubelet/PNS/Emissary

```bash
# Logs from the workflow controller:
kubectl logs -n argo deploy/workflow-controller | grep ${workflow}

Expand Down
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/regression.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
name: Regression report
about: Create a regression report. Not for support requests.
labels: ['bug', 'regression', 'triage']
---
## Summary

What happened/what you expected to happen?

What version is it broken in?

What version was it working in?

## Diagnostics

Either a workflow that reproduces the bug, or paste you whole workflow YAML, including status, something like:

```yaml
kubectl get wf -o yaml ${workflow}
```

What Kubernetes provider are you using?

What executor are you running? Docker/K8SAPI/Kubelet/PNS/Emissary

```bash
# Logs from the workflow controller:
kubectl logs -n argo deploy/workflow-controller | grep ${workflow}

# 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
```

---
<!-- Issue Author: Don't delete this message to encourage other users to support your issue! -->
**Message from the maintainers**:

Impacted by this bug? Give it a 👍. We prioritise the issues with the most 👍.
72 changes: 0 additions & 72 deletions .github/ISSUE_TEMPLATE/regression.yml

This file was deleted.

0 comments on commit 63aecdb

Please sign in to comment.