From 4086ab15fa3741f5340736d902cd86d65813d682 Mon Sep 17 00:00:00 2001 From: Hidde Beydals Date: Mon, 26 Jul 2021 14:55:08 +0200 Subject: [PATCH] Transform GitHub issue template to new format This will help users to provide bug reports of high quality, as the requested information is now rendered into dedicated fields, while allowing us to mark fields as "required". Signed-off-by: Hidde Beydals --- .github/ISSUE_TEMPLATE/bug_report.md | 46 -------------- .github/ISSUE_TEMPLATE/bug_report.yaml | 84 ++++++++++++++++++++++++++ 2 files changed, 84 insertions(+), 46 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 6a6d46d8..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve Flux v2 -title: '' -assignees: '' - ---- - - - -### Describe the bug - -A clear and concise description of what the bug is. - -### To Reproduce - -Steps to reproduce the behaviour: - -1. Provide Flux install instructions -2. Provide a GitHub repository with Kubernetes manifests - -### Expected behavior - -A clear and concise description of what you expected to happen. - -### Additional context - -- Kubernetes version: -- Git provider: -- Container registry provider: - -Below please provide the output of the following commands: - -```cli -flux --version -flux check -kubectl -n get all -kubectl -n logs deploy/source-controller -kubectl -n logs deploy/kustomize-controller -``` diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 00000000..5cba287c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,84 @@ +--- +name: Bug report +description: Create a report to help us improve Flux v2 +body: +- type: markdown + attributes: + value: | + ## Support + Find out more about your support options and getting help at: https://fluxcd.io/support/ +- type: textarea + validations: + required: true + attributes: + label: Describe the bug + description: A clear description of what the bug is. +- type: textarea + validations: + required: true + attributes: + label: Steps to reproduce + description: | + Steps to reproduce the problem. + placeholder: | + For example: + 1. Install Flux with the additional image automation controllers + 2. Run command '...' + 3. See error +- type: textarea + validations: + required: true + attributes: + label: Expected behavior + description: A brief description of what you expected to happen. +- type: textarea + attributes: + label: Screenshots and recordings + description: | + If applicable, add screenshots to help explain your problem. You can also record an asciinema session: https://asciinema.org/ +- type: input + validations: + required: true + attributes: + label: OS / Distro + placeholder: e.g. Windows 10, Ubuntu 20.04, Arch Linux, macOS 10.15... +- type: input + validations: + required: true + attributes: + label: Flux version + description: Run `flux --version` to check. + placeholder: e.g. 0.16.1 +- type: textarea + validations: + required: true + attributes: + label: Flux check + description: Run `flux check` to check. + placeholder: | + For example: + ► checking prerequisites + ✔ kubectl 1.21.0 >=1.18.0-0 + ✔ Kubernetes 1.21.1 >=1.16.0-0 + ► checking controllers + ✔ all checks passed +- type: input + attributes: + label: Git provider + description: If applicable, add the Git provider you are having problems with, e.g. GitHub (Enterprise), GitLab, etc. +- type: input + attributes: + label: Container Registry provider + description: If applicable, add the Container Registry provider you are having problems with, e.g. DockerHub, GitHub Packages, Quay.io, etc. +- type: textarea + attributes: + label: Additional context + description: Add any other context about the problem here. This can be logs (e.g. output from `flux logs`), environment specific caveats, etc. +- type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/fluxcd/.github/blob/main/CODE_OF_CONDUCT.md) + options: + - label: I agree to follow this project's Code of Conduct + required: true