1
0
Fork 0
mirror of https://github.com/prometheus-operator/prometheus-operator.git synced 2025-04-21 11:48:53 +00:00

chore: create new bug issue template

Based on github's new issue template form
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms

Signed-off-by: Jayapriya Pai <slashpai9@gmail.com>
This commit is contained in:
Jayapriya Pai 2023-11-20 21:23:47 +05:30
parent e2a722cf3e
commit 71e923b114
No known key found for this signature in database
GPG key ID: 36980D18029049BD
2 changed files with 106 additions and 52 deletions
.github/ISSUE_TEMPLATE

View file

@ -1,52 +0,0 @@
---
name: Bug
about: Report a bug related to the Prometheus Operator
labels: kind/bug
---
<!--
Feel free to ask questions in #prometheus-operator on Kubernetes Slack!
Note: This repository is about prometheus-operator itself, if you have questions about:
- helm installation, go to https://github.com/prometheus-community/helm-charts repository
- kube-prometheus setup, go to https://github.com/prometheus-operator/kube-prometheus
-->
**What happened?**
**Did you expect to see something different?**
**How to reproduce it (as minimally and precisely as possible)**:
**Environment**
* Prometheus Operator version:
`Insert image tag or Git SHA here`
<!-- Try kubectl -n monitoring describe deployment prometheus-operator -->
<!-- Note: please provide operator version and not kube-prometheus/helm chart version -->
* Kubernetes version information:
`kubectl version`
<!-- Replace the command with its output above -->
* Kubernetes cluster kind:
insert how you created your cluster: kops, bootkube, etc.
* Manifests:
```
insert manifests relevant to the issue
```
* Prometheus Operator Logs:
```
insert Prometheus Operator logs relevant to the issue here
```
**Anything else we need to know?**:

106
.github/ISSUE_TEMPLATE/bug.yaml vendored Normal file
View file

@ -0,0 +1,106 @@
name: 🐞 Bug
description: Report a bug related to the Prometheus operator
labels: ["kind/bug", "needs-triage"]
body:
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: |
Before filing a bug, please be sure you have searched through [existing bugs](https://github.com/prometheus-operator/prometheus-operator/issues?q=is%3Aopen+is%3Aissue+label%3Akind%2Fbug) to see if an existing issue covers your bug.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: What happened?
description: A concise description of what you're experiencing.
value: |
## Description
## Steps to Reproduce
## Expected Result
## Actual Result
validations:
required: true
- type: textarea
attributes:
label: Prometheus Operator Version
description: |
Provide the prometheus-operator version used
This will be automatically formatted into code, so no need for backticks.
placeholder: |
- Prometheus Operator version (please provide operator version and not kube-prometheus/helm chart version):
```console
Try kubectl -n <namespace> describe deployment/prometheus-operator
# paste output here
```
render: shell
validations:
required: true
- type: textarea
attributes:
label: Kubernetes Version
description: |
Paste the output of `kubectl version -o yaml`
This will be automatically formatted into code, so no need for backticks.
render: yaml
validations:
required: true
- type: dropdown
attributes:
label: Kubernetes Cluster Type
description: Select Kubernetes cluster type
options:
- kind
- minikube
- kubeadm
- OpenShift
- EKS
- GKE
- AKS
- Rancher
- Other (please comment)
validations:
required: true
- type: dropdown
attributes:
label: How did you deploy Prometheus-Operator?
description: |
Select the method how you deployed prometheus-operator
options:
- prometheus-operator/kube-prometheus
- helm chart:prometheus-community/kube-prometheus-stack
- yaml manifests
- Other (please comment)
validations:
required: true
- type: textarea
attributes:
label: Manifests
description: |
Insert manifests relevant to the issue
This will be automatically formatted into code, so no need for backticks.
render: yaml
validations:
required: false
- type: textarea
attributes:
label: prometheus-operator log output
description: |
Please provide prometheus-operator log output
This will be automatically formatted into code, so no need for backticks.
render: shell
validations:
required: true
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
Tip: You can attach images or any other relevant log files by clicking this area to highlight it and then dragging files in.
validations:
required: false