From 17bb74308c6d4dbf468cb2431d5c16661b37b251 Mon Sep 17 00:00:00 2001 From: Lewis Date: Mon, 31 Mar 2025 19:43:33 +1000 Subject: [PATCH] Update Buildah issue template to new version and support podman build Signed-off-by: Lewis Denny --- .github/ISSUE_TEMPLATE.md | 71 ---------- .../ISSUE_TEMPLATE/buildah_bug_report.yaml | 99 +++++++++++++ .github/ISSUE_TEMPLATE/config.yaml | 11 ++ .../podman_build_bug_report.yaml | 133 ++++++++++++++++++ 4 files changed, 243 insertions(+), 71 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/buildah_bug_report.yaml create mode 100644 .github/ISSUE_TEMPLATE/config.yaml create mode 100644 .github/ISSUE_TEMPLATE/podman_build_bug_report.yaml diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index a45826295..000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,71 +0,0 @@ - - -**Description** - - - -**Steps to reproduce the issue:** -1. -2. -3. - - -**Describe the results you received:** - - -**Describe the results you expected:** - - -**Output of `rpm -q buildah` or `apt list buildah`:** - -``` -(paste your output here) -``` - -**Output of `buildah version`:** - -``` -(paste your output here) -``` - -**Output of `podman version` if reporting a `podman build` issue:** - -``` -(paste your output here) -``` - -**Output of `cat /etc/*release`:** - -``` -(paste your output here) -``` - -**Output of `uname -a`:** - -``` -(paste your output here) -``` - -**Output of `cat /etc/containers/storage.conf`:** - -``` -(paste your output here) -``` diff --git a/.github/ISSUE_TEMPLATE/buildah_bug_report.yaml b/.github/ISSUE_TEMPLATE/buildah_bug_report.yaml new file mode 100644 index 000000000..05d6e68ef --- /dev/null +++ b/.github/ISSUE_TEMPLATE/buildah_bug_report.yaml @@ -0,0 +1,99 @@ +--- +name: Buildah Bug Report +description: File a Buildah bug report +labels: ["kind/bug", "triage-needed"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + + **NOTE** A large number of issues reported against Buildah are often found to already be fixed in more current versions of the project. + Before reporting an issue, please verify the version you are running with `buildah version` and compare it to the latest released version under + [releases](https://github.com/containers/buildah/releases). + If they differ, please update your version of Buildah to the latest possible and retry your command before creating an issue. + + Commands you might need to run to create the issue + $ `buildah version` + $ `buildah info` + $ `rpm -q buildah` or `apt list buildah` + - type: textarea + id: description + attributes: + label: Issue Description + description: Please explain your issue + value: "Describe your issue" + validations: + required: true + - type: textarea + id: reproducer + attributes: + label: Steps to reproduce the issue + description: Please explain the steps to reproduce the issue + value: "Steps to reproduce the issue\n1.\n2.\n3.\n" + validations: + required: true + - type: textarea + id: received_results + attributes: + label: Describe the results you received + description: Please explain the results you are noticing + value: "Describe the results you received" + validations: + required: true + - type: textarea + id: expected_results + attributes: + label: Describe the results you expected + description: Please explain the results you are expecting + value: "Describe the results you expected" + validations: + required: true + - type: textarea + id: buildah_version + attributes: + label: buildah version output + description: Please copy and paste `buildah version` output. + value: If you are unable to run `buildah version` for any reason, please provide the output of `rpm -q buildah` or `apt list buildah`. + render: yaml + validations: + required: true + - type: textarea + id: buildah_info + attributes: + label: buildah info output + description: Please copy and paste `buildah info` output. + value: If you are unable to run `buildah info` for any reason, please provide the operating system and its version and the architecture you are running. + render: yaml + validations: + required: true + - type: textarea + id: storage_conf + attributes: + label: Provide your storage.conf + description: "Please provide the relevant [storage.conf file](https://github.com/containers/storage/blob/main/docs/containers-storage.conf.5.md#files)" + render: toml + validations: + required: true + - type: dropdown + id: upstream_latest + attributes: + label: Upstream Latest Release + description: Have you tried running the [latest upstream release](https://github.com/containers/buildah/releases/latest) + options: + - "Yes" + - "No" + validations: + required: true + - type: textarea + id: additional_environment + attributes: + label: Additional environment details + description: Please describe any additional environment details like (AWS, VirtualBox,...) + value: "Additional environment details" + - type: textarea + id: additional_info + attributes: + label: Additional information + description: Please explain the additional information you deem important + value: "Additional information like issue happens only occasionally or issue happens with a particular architecture or on a particular setting" diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml new file mode 100644 index 000000000..29b9e602d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yaml @@ -0,0 +1,11 @@ +--- +blank_issues_enabled: true +contact_links: + - name: Ask a question + url: https://github.com/containers/buildah/discussions/new + about: Ask a question about Buildah + - name: + If your issue is a general Podman issue unrelated to `podman build`, please open an issue in the Podman repository. + If the issue is with the `podman build` command, please report it here. + url: https://github.com/containers/podman/issues + about: Please report issues with Podman here. diff --git a/.github/ISSUE_TEMPLATE/podman_build_bug_report.yaml b/.github/ISSUE_TEMPLATE/podman_build_bug_report.yaml new file mode 100644 index 000000000..0d145bd7c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/podman_build_bug_report.yaml @@ -0,0 +1,133 @@ +--- +name: Podman Build Bug Report +description: File a Podman build bug report +labels: ["kind/bug", "triage-needed"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + + **NOTE** A large number of issues reported against Buildah are often found to already be fixed in more current versions of the project. + Before reporting an issue, please verify the version you are running with `podman version` and compare it to the latest released version under + [releases](https://github.com/containers/podman/releases). + If they differ, please update your version of Podman to the latest possible and retry your command before creating an issue. + + Commands you might need to run to create the issue + $ `podman version` + $ `podman info` + $ `rpm -q podman` or `apt list podman` + - type: textarea + id: description + attributes: + label: Issue Description + description: Please explain your issue + value: "Describe your issue" + validations: + required: true + - type: textarea + id: reproducer + attributes: + label: Steps to reproduce the issue + description: Please explain the steps to reproduce the issue + value: "Steps to reproduce the issue\n1.\n2.\n3.\n" + validations: + required: true + - type: textarea + id: received_results + attributes: + label: Describe the results you received + description: Please explain the results you are noticing + value: "Describe the results you received" + validations: + required: true + - type: textarea + id: expected_results + attributes: + label: Describe the results you expected + description: Please explain the results you are expecting + value: "Describe the results you expected" + validations: + required: true + - type: textarea + id: podman_version + attributes: + label: podman version output + description: Please copy and paste `podman version` output. + value: If you are unable to run `podman version` for any reason, please provide the output of `rpm -q podman` or `apt list podman`. + render: yaml + validations: + required: true + - type: textarea + id: podman_info + attributes: + label: podman info output + description: Please copy and paste `podman info` output. + value: If you are unable to run `podman info` for any reason, please provide the operating system and its version and the architecture you are running. + render: yaml + validations: + required: true + - type: textarea + id: storage_conf + attributes: + label: Provide your storage.conf + description: "Please provide the relevant [storage.conf file](https://github.com/containers/storage/blob/main/docs/containers-storage.conf.5.md#files)" + render: toml + validations: + required: true + - type: dropdown + id: podman_in_a_container + attributes: + label: Podman in a container + description: Please select Yes if you are running Podman in a container + options: + - "No" + - "Yes" + validations: + required: true + - type: dropdown + id: privileged_rootless + attributes: + label: Privileged Or Rootless + description: + Are you running the containers as privileged or non-root user? Note that using `su` or `sudo` does not establish a proper login session required for running + Podman as a non-root user. Please refer to the [troubleshooting guide](https://github.com/containers/podman/blob/main/troubleshooting.md#solution-28) for alternatives. + options: + - Privileged + - Rootless + - type: dropdown + id: upstream_latest + attributes: + label: Upstream Latest Release + description: Have you tried running the [latest upstream release](https://github.com/containers/podman/releases/latest) + options: + - "Yes" + - "No" + validations: + required: true + - type: dropdown + id: installation_source + attributes: + label: Installation Source + description: What installion type did you use? + multiple: false + options: + - Distribution package (DNF, apt, yay) + - Brew + - Offical Podman Installer (Mac) + - Podman Desktop + default: 0 + validations: + required: true + - type: textarea + id: additional_environment + attributes: + label: Additional environment details + description: Please describe any additional environment details like (AWS, VirtualBox,...) + value: "Additional environment details" + - type: textarea + id: additional_info + attributes: + label: Additional information + description: Please explain the additional information you deem important + value: "Additional information like issue happens only occasionally or issue happens with a particular architecture or on a particular setting"