Skip to content

Commit dbcb679

Browse files
mumoshutoast-gear
mumoshu
and
toast-gear
authored
Turn the bug report template into a form with more context (#1401)
I believe this helps us focus on relatively more important issues like critical bug reports and highly-requested feature requests. Co-authored-by: Callum Tait <[email protected]>
1 parent 55369bf commit dbcb679

File tree

4 files changed

+177
-107
lines changed

4 files changed

+177
-107
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 107 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
name: Bug Report
2+
description: File a bug report
3+
title: "Bug"
4+
labels: ["bug"]
5+
body:
6+
- type: input
7+
id: controller-version
8+
attributes:
9+
label: Controller Version
10+
description: Refer to semver-like release tags for controller versions. Any release tags prefixed with `actions-runner-controller-` are for chart releases
11+
placeholder: ex. 0.18.2 or git commit ID
12+
validations:
13+
required: true
14+
- type: input
15+
id: chart-version
16+
attributes:
17+
label: Helm Chart Version
18+
description: Run `helm list` and see what's shown under CHART VERSION. Any release tags prefixed with `actions-runner-controller-` are for chart releases
19+
placeholder: ex. 0.11.0
20+
- type: dropdown
21+
id: deployment-method
22+
attributes:
23+
label: Deployment Method
24+
description: Which deployment method did you use to install ARC?
25+
options:
26+
- Helm
27+
- Kustomize
28+
- ArgoCD
29+
- Other
30+
validations:
31+
required: true
32+
- type: checkboxes
33+
id: checks
34+
attributes:
35+
label: Checks
36+
description: Please check the boxes below before submitting
37+
options:
38+
- label: This isn't a question or user support case (For Q&A and community support, go to [Discussions](https://github.com/actions-runner-controller/actions-runner-controller/discussions). It might also be a good idea to contract with any of contributors and maintainers if your business is so critical and therefore you need priority support
39+
required: true
40+
- label: I've read [releasenotes](https://github.com/actions-runner-controller/actions-runner-controller/tree/master/docs/releasenotes) before submitting this issue and I'm sure it's not due to any recently-introduced backward-incompatible changes
41+
required: true
42+
- label: My actions-runner-controller version (v0.x.y) does support the feature
43+
required: true
44+
- label: I've already upgraded ARC to the latest and it didn't fix the issue
45+
required: true
46+
- type: textarea
47+
id: resource-definitions
48+
attributes:
49+
label: Resource Definitions
50+
description: "Add copy(s) of your resource definition(s) (RunnerDeployment or RunnerSet, and HorizontalRunnerAutoscaler. If RunnerSet, also include the StorageClass being used)"
51+
render: yaml
52+
placeholder: |
53+
apiVersion: actions.summerwind.dev/v1alpha1
54+
kind: RunnerDeployment
55+
metadata:
56+
name: example
57+
spec:
58+
#snip
59+
---
60+
apiVersion: actions.summerwind.dev/v1alpha1
61+
kind: RunnerSet
62+
metadata:
63+
name: example
64+
spec:
65+
#snip
66+
---
67+
apiVersion: storage.k8s.io/v1
68+
kind: StorageClass
69+
metadata:
70+
name: example
71+
provisioner: ...
72+
reclaimPolicy: ...
73+
volumeBindingMode: ...
74+
---
75+
apiVersion: actions.summerwind.dev/v1alpha1
76+
kind: HorizontalRunnerAutoscaler
77+
metadata:
78+
name:
79+
spec:
80+
#snip
81+
validations:
82+
required: true
83+
- type: textarea
84+
id: reproduction-steps
85+
attributes:
86+
label: To Reproduce
87+
description: "Steps to reproduce the behavior"
88+
render: markdown
89+
placeholder: |
90+
1. Go to '...'
91+
2. Click on '....'
92+
3. Scroll down to '....'
93+
4. See error
94+
validations:
95+
required: true
96+
- type: textarea
97+
id: actual-behavior
98+
attributes:
99+
label: Describe the bug
100+
description: Also tell us, what did happen?
101+
placeholder: A clear and concise description of what happened.
102+
validations:
103+
required: true
104+
- type: textarea
105+
id: expected-behavior
106+
attributes:
107+
label: Describe the expected behavior
108+
description: Also tell us, what did you expect to happen?
109+
placeholder: A clear and concise description of what the expected behavior is.
110+
validations:
111+
required: true
112+
- type: textarea
113+
id: controller-logs
114+
attributes:
115+
label: Controller Logs
116+
description: "Include logs from `actions-runner-controller`'s controller-manager pod"
117+
render: shell
118+
placeholder: |
119+
To grab controller logs:
120+
121+
# Set NS according to your setup
122+
NS=actions-runner-system
123+
124+
# Grab the pod name and set it to $POD_NAME
125+
kubectl -n $NS get po
126+
127+
kubectl -n $NS logs $POD_NAME > arc.log
128+
129+
Upload it to e.g. https://gist.github.com/ and paste the link to it here.
130+
validations:
131+
required: true
132+
- type: textarea
133+
id: runner-pod-logs
134+
attributes:
135+
label: Runner Pod Logs
136+
description: "Include logs from runner pod(s)"
137+
render: shell
138+
placeholder: |
139+
To grab the runner pod logs:
140+
141+
# Set NS according to your setup. It should match your RunnerDeployment's metadata.namespace.
142+
NS=default
143+
144+
# Grab the name of the problematic runner pod and set it to $POD_NAME
145+
kubectl -n $NS get po
146+
147+
kubectl -n $NS logs $POD_NAME -c runner > runnerpod_runner.log
148+
kubectl -n $NS logs $POD_NAME -c docker > runnerpod_docker.log
149+
150+
Upload it to e.g. https://gist.github.com/ and paste the link to it here.
151+
validations:
152+
required: true
153+
- type: textarea
154+
id: additional-context
155+
attributes:
156+
label: Additional Context
157+
description: |
158+
Add any other context about the problem here.
159+
160+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Blank issues are mainly for maintainers who are known to write complete issue descriptions without need to following a form
2+
blank_issues_enabled: true
3+
contact_links:
4+
- name: Sponsor ARC Maintainers
5+
about: If your business relies on the continued maintainance of actions-runner-controller, please consider sponsoring the project and the maintainers.
6+
url: https://github.com/actions-runner-controller/actions-runner-controller/tree/master/CODEOWNERS
7+
- name: Ideas and Feature Requests
8+
about: Wanna request a feature? Create a discussion and collect :+1:s first.
9+
url: https://github.com/actions-runner-controller/actions-runner-controller/discussions/new?category=ideas
10+
- name: Questions and User Support
11+
about: Need support using ARC? We use Discussions as the place to provide community support.
12+
url: https://github.com/actions-runner-controller/actions-runner-controller/discussions/new?category=questions
13+
- name: Need Paid Support?
14+
about: Consider contracting with any of the actions-runner-controller maintainers and contributors.
15+
url: https://github.com/actions-runner-controller/actions-runner-controller/tree/master/CODEOWNERS

‎CODEOWNERS

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# actions-runner-controller maintainers
2+
* @mumoshu @toast-gear

0 commit comments

Comments
 (0)