From d6c5839bab0a1606fa393a6bc9b83a2c1e33b4dc Mon Sep 17 00:00:00 2001 From: Max Gautier Date: Mon, 15 Jan 2024 09:29:37 +0100 Subject: [PATCH] Convert issue templates to issues forms (#10793) * Convert the bug-report template to issue form * Convert the enchancement issue template to form * Convert "Failing Test" template to issue form * github: Remove support request template, direct to slack instead --- .github/ISSUE_TEMPLATE/bug-report.md | 44 --------- .github/ISSUE_TEMPLATE/bug-report.yaml | 117 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 + .github/ISSUE_TEMPLATE/enhancement.md | 11 --- .github/ISSUE_TEMPLATE/enhancement.yaml | 20 ++++ .github/ISSUE_TEMPLATE/failing-test.md | 20 ---- .github/ISSUE_TEMPLATE/failing-test.yaml | 41 ++++++++ .github/ISSUE_TEMPLATE/support.md | 18 ---- 8 files changed, 183 insertions(+), 93 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yaml create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/enhancement.md create mode 100644 .github/ISSUE_TEMPLATE/enhancement.yaml delete mode 100644 .github/ISSUE_TEMPLATE/failing-test.md create mode 100644 .github/ISSUE_TEMPLATE/failing-test.yaml delete mode 100644 .github/ISSUE_TEMPLATE/support.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index 3ead734e727..00000000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -name: Bug Report -about: Report a bug encountered while operating Kubernetes -labels: kind/bug - ---- - - -**Environment**: -- **Cloud provider or hardware configuration:** - -- **OS (`printf "$(uname -srm)\n$(cat /etc/os-release)\n"`):** - -- **Version of Ansible** (`ansible --version`): - -- **Version of Python** (`python --version`): - - -**Kubespray version (commit) (`git rev-parse --short HEAD`):** - - -**Network plugin used**: - - -**Full inventory with variables (`ansible -i inventory/sample/inventory.ini all -m debug -a "var=hostvars[inventory_hostname]"`):** - - -**Command used to invoke ansible**: - - -**Output of ansible run**: - - -**Anything else do we need to know**: - diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml new file mode 100644 index 00000000000..20aed31a89b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -0,0 +1,117 @@ +--- +name: Bug Report +description: Report a bug encountered while operating Kubernetes +labels: kind/bug +body: + - type: markdown + attributes: + value: | + Please, be ready for followup questions, and please respond in a timely + manner. If we can't reproduce a bug or think a feature already exists, we + might close your issue. If we're wrong, PLEASE feel free to reopen it and + explain why. + - type: textarea + id: problem + attributes: + label: What happened? + description: | + Please provide as much info as possible. Not doing so may result in your bug not being addressed in a timely manner. + validations: + required: true + - type: textarea + id: expected + attributes: + label: What did you expect to happen? + validations: + required: true + + - type: textarea + id: repro + attributes: + label: How can we reproduce it (as minimally and precisely as possible)? + validations: + required: true + + - type: markdown + attributes: + value: '### Environment' + + - type: textarea + id: os + attributes: + label: OS + placeholder: 'printf "$(uname -srm)\n$(cat /etc/os-release)\n"' + validations: + required: true + + - type: textarea + id: ansible_version + attributes: + label: Version of Ansible + placeholder: 'ansible --version' + validations: + required: true + + - type: input + id: python_version + attributes: + label: Version of Python + placeholder: 'python --version' + validations: + required: true + + - type: input + id: kubespray_version + attributes: + label: Version of Kubespray (commit) + placeholder: 'git rev-parse --short HEAD' + validations: + required: true + + - type: dropdown + id: network_plugin + attributes: + label: Network plugin used + options: + - calico + - cilium + - cni + - custom_cni + - flannel + - kube-ovn + - kube-router + - macvlan + - meta + - multus + - ovn4nfv + - weave + validations: + required: true + + - type: textarea + id: inventory + attributes: + label: Full inventory with variables + placeholder: 'ansible -i inventory/sample/inventory.ini all -m debug -a "var=hostvars[inventory_hostname]"' + + - type: input + id: ansible_command + attributes: + label: Command used to invoke ansible + + - type: textarea + id: ansible_output + attributes: + label: Output of ansible run + description: We recommend using snippets services like https://gist.github.com/ etc. + + - type: textarea + id: anything_else + attributes: + label: Anything else we need to know + description: | + By running scripts/collect-info.yaml you can get a lot of useful informations. + Script can be started by: + ansible-playbook -i -u -e ansible_ssh_user= -b --become-user=root -e dir=`pwd` scripts/collect-info.yaml + (If you using CoreOS remember to add '-e ansible_python_interpreter=/opt/bin/python'). + After running this command you can find logs in `pwd`/logs.tar.gz. You can even upload somewhere entire file and paste link here diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000000..aa9c1813005 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +--- +contact_links: + - name: Support Request + url: https://kubernetes.slack.com/channels/kubespray + about: Support request or question relating to Kubernetes diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md deleted file mode 100644 index 3680571358f..00000000000 --- a/.github/ISSUE_TEMPLATE/enhancement.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -name: Enhancement Request -about: Suggest an enhancement to the Kubespray project -labels: kind/feature - ---- - - -**What would you like to be added**: - -**Why is this needed**: diff --git a/.github/ISSUE_TEMPLATE/enhancement.yaml b/.github/ISSUE_TEMPLATE/enhancement.yaml new file mode 100644 index 00000000000..c0232069e9b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.yaml @@ -0,0 +1,20 @@ +--- +name: Enhancement Request +description: Suggest an enhancement to the Kubespray project +labels: kind/feature +body: + - type: markdown + attributes: + value: Please only use this template for submitting enhancement requests + - type: textarea + id: what + attributes: + label: What would you like to be added + validations: + required: true + - type: textarea + id: why + attributes: + label: Why is this needed + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/failing-test.md b/.github/ISSUE_TEMPLATE/failing-test.md deleted file mode 100644 index cb4f1a74fff..00000000000 --- a/.github/ISSUE_TEMPLATE/failing-test.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Failing Test -about: Report test failures in Kubespray CI jobs -labels: kind/failing-test - ---- - - - -**Which jobs are failing**: - -**Which test(s) are failing**: - -**Since when has it been failing**: - -**Testgrid link**: - -**Reason for failure**: - -**Anything else we need to know**: diff --git a/.github/ISSUE_TEMPLATE/failing-test.yaml b/.github/ISSUE_TEMPLATE/failing-test.yaml new file mode 100644 index 00000000000..9a19d8485c8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/failing-test.yaml @@ -0,0 +1,41 @@ +--- +name: Failing Test +description: Report test failures in Kubespray CI jobs +labels: kind/failing-test +body: + - type: markdown + attributes: + value: Please only use this template for submitting reports about failing tests in Kubespray CI jobs + - type: textarea + id: failing_jobs + attributes: + label: Which jobs are failing ? + validations: + required: true + + - type: textarea + id: failing_tests + attributes: + label: Which tests are failing ? + validations: + required: true + + - type: input + id: since_when + attributes: + label: Since when has it been failing ? + validations: + required: true + + - type: textarea + id: failing_tests + attributes: + label: Reason for failure + description: If you don't know and have no guess, just put "Unknown" + validations: + required: true + + - type: textarea + id: anything_else + attributes: + label: Anything else we need to know diff --git a/.github/ISSUE_TEMPLATE/support.md b/.github/ISSUE_TEMPLATE/support.md deleted file mode 100644 index ddec84127bf..00000000000 --- a/.github/ISSUE_TEMPLATE/support.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -name: Support Request -about: Support request or question relating to Kubespray -labels: kind/support - ---- - -