-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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]>
- Loading branch information
1 parent
55369bf
commit dbcb679
Showing
4 changed files
with
177 additions
and
107 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,160 @@ | ||
name: Bug Report | ||
description: File a bug report | ||
title: "Bug" | ||
labels: ["bug"] | ||
body: | ||
- type: input | ||
id: controller-version | ||
attributes: | ||
label: Controller Version | ||
description: Refer to semver-like release tags for controller versions. Any release tags prefixed with `actions-runner-controller-` are for chart releases | ||
placeholder: ex. 0.18.2 or git commit ID | ||
validations: | ||
required: true | ||
- type: input | ||
id: chart-version | ||
attributes: | ||
label: Helm Chart Version | ||
description: Run `helm list` and see what's shown under CHART VERSION. Any release tags prefixed with `actions-runner-controller-` are for chart releases | ||
placeholder: ex. 0.11.0 | ||
- type: dropdown | ||
id: deployment-method | ||
attributes: | ||
label: Deployment Method | ||
description: Which deployment method did you use to install ARC? | ||
options: | ||
- Helm | ||
- Kustomize | ||
- ArgoCD | ||
- Other | ||
validations: | ||
required: true | ||
- type: checkboxes | ||
id: checks | ||
attributes: | ||
label: Checks | ||
description: Please check the boxes below before submitting | ||
options: | ||
- 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 | ||
required: true | ||
- 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 | ||
required: true | ||
- label: My actions-runner-controller version (v0.x.y) does support the feature | ||
required: true | ||
- label: I've already upgraded ARC to the latest and it didn't fix the issue | ||
required: true | ||
- type: textarea | ||
id: resource-definitions | ||
attributes: | ||
label: Resource Definitions | ||
description: "Add copy(s) of your resource definition(s) (RunnerDeployment or RunnerSet, and HorizontalRunnerAutoscaler. If RunnerSet, also include the StorageClass being used)" | ||
render: yaml | ||
placeholder: | | ||
apiVersion: actions.summerwind.dev/v1alpha1 | ||
kind: RunnerDeployment | ||
metadata: | ||
name: example | ||
spec: | ||
#snip | ||
--- | ||
apiVersion: actions.summerwind.dev/v1alpha1 | ||
kind: RunnerSet | ||
metadata: | ||
name: example | ||
spec: | ||
#snip | ||
--- | ||
apiVersion: storage.k8s.io/v1 | ||
kind: StorageClass | ||
metadata: | ||
name: example | ||
provisioner: ... | ||
reclaimPolicy: ... | ||
volumeBindingMode: ... | ||
--- | ||
apiVersion: actions.summerwind.dev/v1alpha1 | ||
kind: HorizontalRunnerAutoscaler | ||
metadata: | ||
name: | ||
spec: | ||
#snip | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: reproduction-steps | ||
attributes: | ||
label: To Reproduce | ||
description: "Steps to reproduce the behavior" | ||
render: markdown | ||
placeholder: | | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: actual-behavior | ||
attributes: | ||
label: Describe the bug | ||
description: Also tell us, what did happen? | ||
placeholder: A clear and concise description of what happened. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: expected-behavior | ||
attributes: | ||
label: Describe the expected behavior | ||
description: Also tell us, what did you expect to happen? | ||
placeholder: A clear and concise description of what the expected behavior is. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: controller-logs | ||
attributes: | ||
label: Controller Logs | ||
description: "Include logs from `actions-runner-controller`'s controller-manager pod" | ||
render: shell | ||
placeholder: | | ||
To grab controller logs: | ||
# Set NS according to your setup | ||
NS=actions-runner-system | ||
# Grab the pod name and set it to $POD_NAME | ||
kubectl -n $NS get po | ||
kubectl -n $NS logs $POD_NAME > arc.log | ||
Upload it to e.g. https://gist.github.com/ and paste the link to it here. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: runner-pod-logs | ||
attributes: | ||
label: Runner Pod Logs | ||
description: "Include logs from runner pod(s)" | ||
render: shell | ||
placeholder: | | ||
To grab the runner pod logs: | ||
# Set NS according to your setup. It should match your RunnerDeployment's metadata.namespace. | ||
NS=default | ||
# Grab the name of the problematic runner pod and set it to $POD_NAME | ||
kubectl -n $NS get po | ||
kubectl -n $NS logs $POD_NAME -c runner > runnerpod_runner.log | ||
kubectl -n $NS logs $POD_NAME -c docker > runnerpod_docker.log | ||
Upload it to e.g. https://gist.github.com/ and paste the link to it here. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: additional-context | ||
attributes: | ||
label: Additional Context | ||
description: | | ||
Add any other context about the problem here. | ||
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Blank issues are mainly for maintainers who are known to write complete issue descriptions without need to following a form | ||
blank_issues_enabled: true | ||
contact_links: | ||
- name: Sponsor ARC Maintainers | ||
about: If your business relies on the continued maintainance of actions-runner-controller, please consider sponsoring the project and the maintainers. | ||
url: https://github.com/actions-runner-controller/actions-runner-controller/tree/master/CODEOWNERS | ||
- name: Ideas and Feature Requests | ||
about: Wanna request a feature? Create a discussion and collect :+1:s first. | ||
url: https://github.com/actions-runner-controller/actions-runner-controller/discussions/new?category=ideas | ||
- name: Questions and User Support | ||
about: Need support using ARC? We use Discussions as the place to provide community support. | ||
url: https://github.com/actions-runner-controller/actions-runner-controller/discussions/new?category=questions | ||
- name: Need Paid Support? | ||
about: Consider contracting with any of the actions-runner-controller maintainers and contributors. | ||
url: https://github.com/actions-runner-controller/actions-runner-controller/tree/master/CODEOWNERS |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# actions-runner-controller maintainers | ||
* @mumoshu @toast-gear |