From ea2443a410fce4629488b1fde14ed4244d327d03 Mon Sep 17 00:00:00 2001 From: Nikola Jokic Date: Mon, 16 Oct 2023 11:49:23 +0200 Subject: [PATCH] Include separate reports associated with Bug/Feature templates (#2938) --- .github/ISSUE_TEMPLATE/config.yml | 3 + .github/ISSUE_TEMPLATE/github_bug_report.yaml | 113 ++++++++++++++++++ ..._report.yml => summerwind_bug_report.yaml} | 12 +- ...quest.md => summerwind_feature_request.md} | 4 +- 4 files changed, 124 insertions(+), 8 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/github_bug_report.yaml rename .github/ISSUE_TEMPLATE/{bug_report.yml => summerwind_bug_report.yaml} (97%) rename .github/ISSUE_TEMPLATE/{feature_request.md => summerwind_feature_request.md} (83%) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 09dc005b..5709a741 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,8 @@ blank_issues_enabled: false contact_links: +- name: Feature requests for the gha-runner-scale-set (actions.github.com API group) + about: Feature requests associated with the actions.github.com group should be posted on the GitHub Community Support Forum + url: https://github.com/orgs/community/discussions/categories/actions - 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/actions-runner-controller/tree/master/CODEOWNERS diff --git a/.github/ISSUE_TEMPLATE/github_bug_report.yaml b/.github/ISSUE_TEMPLATE/github_bug_report.yaml new file mode 100644 index 00000000..8422a5d3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/github_bug_report.yaml @@ -0,0 +1,113 @@ +name: Bug Report (actions.github.com API group) +description: File a bug report for actions.github.com API group +title: "" +labels: ["bug", "needs triage", "gha-runner-scale-set"] +body: +- type: checkboxes + id: read-troubleshooting-guide + attributes: + label: Checks + description: Please check all the boxes below before submitting + options: + - label: I've already read https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/troubleshooting-actions-runner-controller-errors and I'm sure my issue is not covered in the troubleshooting guide. + required: true + + - label: I am using charts that are officially provided +- type: input + id: controller-version + attributes: + label: Controller Version + description: Refers to semver-like release tags for controller versions. Any release tags prefixed with `gha-runner-scale-set-` are releases associated with this API group + placeholder: ex. 0.6.1 + validations: + required: true +- 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 all 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/actions-runner-controller/discussions)). + required: true + - label: I've read the [Changelog](https://github.com/actions/actions-runner-controller/blob/master/docs/gha-runner-scale-set-controller/README.md#changelog) before submitting this issue and I'm sure it's not due to any recently-introduced backward-incompatible changes + 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: additional-context + attributes: + label: Additional Context + render: yaml + description: | + Provide `values.yaml` files that are relevant for this issue. PLEASE REDACT ANY INFORMATION THAT SHOULD NOT BE PUBLICALY AVAILABLE, LIKE GITHUB TOKEN FOR EXAMPLE. + placeholder: | + PLEASE REDACT ANY INFORMATION THAT SHOULD NOT BE PUBLICALY AVAILABLE, LIKE GITHUB TOKEN FOR EXAMPLE. + validations: + required: true + +- type: textarea + id: controller-logs + attributes: + label: Controller Logs + description: "NEVER EVER OMIT THIS! Include complete logs from `actions-runner-controller`'s controller-manager pod." + render: shell + placeholder: | + PROVIDE THE LOGS VIA A GIST LINK (https://gist.github.com/), NOT DIRECTLY IN THIS TEXT AREA + + To grab controller logs: + + kubectl logs -n $NAMESPACE deployments/$CONTROLLER_DEPLOYMENT + validations: + required: true +- type: textarea + id: runner-pod-logs + attributes: + label: Runner Pod Logs + description: "Include logs and kubectl describe output from runner pod(s)." + render: shell + placeholder: | + PROVIDE THE WHOLE LOGS VIA A GIST LINK (https://gist.github.com/), NOT DIRECTLY IN THIS TEXT AREA + validations: + required: true + diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/summerwind_bug_report.yaml similarity index 97% rename from .github/ISSUE_TEMPLATE/bug_report.yml rename to .github/ISSUE_TEMPLATE/summerwind_bug_report.yaml index f3255de7..48c2e31e 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/summerwind_bug_report.yaml @@ -1,7 +1,7 @@ -name: Bug Report -description: File a bug report +name: Bug Report (actions.summerwind.net API group) +description: File a bug report for actions.summerwind.net API group title: "" -labels: ["bug", "needs triage"] +labels: ["bug", "needs triage", "community"] body: - type: checkboxes id: read-troubleshooting-guide @@ -146,7 +146,7 @@ body: render: shell placeholder: | PROVIDE THE LOGS VIA A GIST LINK (https://gist.github.com/), NOT DIRECTLY IN THIS TEXT AREA - + To grab controller logs: # Set NS according to your setup @@ -166,7 +166,7 @@ body: render: shell placeholder: | PROVIDE THE WHOLE LOGS VIA A GIST LINK (https://gist.github.com/), NOT DIRECTLY IN THIS TEXT AREA - + To grab the runner pod logs: # Set NS according to your setup. It should match your RunnerDeployment's metadata.namespace. @@ -177,7 +177,7 @@ body: kubectl -n $NS logs $POD_NAME -c runner > runnerpod_runner.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: required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/summerwind_feature_request.md similarity index 83% rename from .github/ISSUE_TEMPLATE/feature_request.md rename to .github/ISSUE_TEMPLATE/summerwind_feature_request.md index 92d392fc..2e6590e6 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/summerwind_feature_request.md @@ -1,7 +1,7 @@ --- -name: Feature request +name: Feature request (actions.summerwind.net API group) about: Suggest an idea for this project -labels: ["enhancement", "needs triage"] +labels: ["enhancement", "needs triage", "community"] title: '' assignees: '' ---