Enhnace log-related fields in the bug report form (#1838)

Both fields can be useless when the reporter thought only one or two lines of the respective logs are relevant and it turned out we had to see another line later.
To avoid such a situation I'd like to change the field labels to include `Whole` so that it looks like `Whole Runner Pod Logs`, and ask to not omit the logs in the field description.
This commit is contained in:
Yusuke Kuoka 2022-10-04 20:29:51 +09:00 committed by GitHub
parent ca96b66fbe
commit 35af24cf03
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 5 deletions

View File

@ -137,8 +137,8 @@ body:
- type: textarea - type: textarea
id: controller-logs id: controller-logs
attributes: attributes:
label: Controller Logs label: Whole Controller Logs
description: "NEVER EVER OMIT THIS! Include logs from `actions-runner-controller`'s controller-manager pod" description: "NEVER EVER OMIT THIS! Include logs from `actions-runner-controller`'s controller-manager pod. Don't omit the parts you think irrelevant!"
render: shell render: shell
placeholder: | placeholder: |
PROVIDE THE LOGS VIA A GIST LINK (https://gist.github.com/), NOT DIRECTLY IN THIS TEXT AREA PROVIDE THE LOGS VIA A GIST LINK (https://gist.github.com/), NOT DIRECTLY IN THIS TEXT AREA
@ -157,11 +157,11 @@ body:
- type: textarea - type: textarea
id: runner-pod-logs id: runner-pod-logs
attributes: attributes:
label: Runner Pod Logs label: Whole Runner Pod Logs
description: "Include logs from runner pod(s)" description: "Include logs from runner pod(s). Please don't omit the parts you think irrelevant!"
render: shell render: shell
placeholder: | placeholder: |
PROVIDE THE LOGS VIA A GIST LINK (https://gist.github.com/), NOT DIRECTLY IN THIS TEXT AREA PROVIDE THE WHOLE LOGS VIA A GIST LINK (https://gist.github.com/), NOT DIRECTLY IN THIS TEXT AREA
To grab the runner pod logs: To grab the runner pod logs:
@ -173,6 +173,8 @@ body:
kubectl -n $NS logs $POD_NAME -c runner > runnerpod_runner.log kubectl -n $NS logs $POD_NAME -c runner > runnerpod_runner.log
kubectl -n $NS logs $POD_NAME -c docker > runnerpod_docker.log kubectl -n $NS logs $POD_NAME -c docker > runnerpod_docker.log
If any of the containers are getting terminated immediately, try adding `--previous` to the kubectl-logs command to obtain logs emitted before the termination.
validations: validations:
required: true required: true
- type: textarea - type: textarea