From 2036a561beba3a0ce58d037343f62a611fc60a88 Mon Sep 17 00:00:00 2001 From: CrazyMax Date: Wed, 16 Aug 2023 08:16:01 +0200 Subject: [PATCH] chore: github form templates Signed-off-by: CrazyMax --- .github/ISSUE_TEMPLATE/bug.yml | 101 +++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 37 ---------- .github/ISSUE_TEMPLATE/config.yml | 9 +++ .github/ISSUE_TEMPLATE/feature.yml | 15 ++++ 4 files changed, 125 insertions(+), 37 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..c75abfc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,101 @@ +# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema +name: Bug Report +description: Report a bug +labels: + - status/triage + +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to report a bug! + If this is a security issue please report it to the [Docker Security team](mailto:security@docker.com). + Before submitting a bug report, check out the [Troubleshooting doc](https://github.com/docker/build-push-action/blob/master/TROUBLESHOOTING.md). + + - type: checkboxes + attributes: + label: Contributing guidelines + description: > + Make sure you've read the contributing guidelines before proceeding. + options: + - label: I've read the [contributing guidelines](https://github.com/docker/build-push-action/blob/master/.github/CONTRIBUTING.md) and wholeheartedly agree + required: true + + - type: checkboxes + attributes: + label: "I've found a bug, and:" + description: | + Make sure that your request fulfills all of the following requirements. + If one requirement cannot be satisfied, explain in detail why. + options: + - label: The documentation does not mention anything about my problem + - label: There are no open or closed issues that are related to my problem + + - type: textarea + attributes: + label: Description + description: > + Provide a brief description of the bug in 1-2 sentences. + validations: + required: true + + - type: textarea + attributes: + label: Expected behaviour + description: > + Describe precisely what you'd expect to happen. + validations: + required: true + + - type: textarea + attributes: + label: Actual behaviour + description: > + Describe precisely what is actually happening. + validations: + required: true + + - type: input + attributes: + label: Repository URL + description: > + Enter the URL of the repository where you are experiencing the + issue. If your repository is private, provide a link to a minimal + repository that reproduces the issue. + + - type: input + attributes: + label: Workflow run URL + description: > + Enter the URL of the GitHub Action workflow run, if public. + + - type: textarea + attributes: + label: YAML workflow + description: | + Provide the YAML of the workflow that's causing the issue. + Make sure to remove any sensitive information. + render: yaml + validations: + required: true + + - type: textarea + attributes: + label: Workflow logs + description: > + [Attach](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/attaching-files) + the [log file of your workflow run](https://docs.github.com/en/actions/managing-workflow-runs/using-workflow-run-logs#downloading-logs) + and make sure to remove any sensitive information. + + - type: textarea + attributes: + label: BuildKit logs + description: > + If applicable, provide the [BuildKit container logs](https://docs.docker.com/build/ci/github-actions/configure-builder/#buildkit-container-logs) + render: text + + - type: textarea + attributes: + label: Additional info + description: | + Provide any additional information that could be useful. diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 6c5a71f..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve ---- - -### Troubleshooting - -Before submitting a bug report please read the [Troubleshooting doc](https://github.com/docker/build-push-action/blob/master/TROUBLESHOOTING.md). - -### Behaviour - -#### Steps to reproduce this issue - -1. -2. -3. - -#### Expected behaviour - -> Tell us what should happen - -#### Actual behaviour - -> Tell us what happens instead - -### Configuration - -* Repository URL (if public): -* Build URL (if public): - -```yml -# paste your YAML workflow file here and remove sensitive data -``` - -### Logs - -> Download the [log file of your build](https://docs.github.com/en/actions/managing-workflow-runs/using-workflow-run-logs#downloading-logs) and [attach it](https://docs.github.com/en/github/managing-your-work-on-github/file-attachments-on-issues-and-pull-requests) to this issue. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..beb52dc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,9 @@ +# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser +blank_issues_enabled: true +contact_links: + - name: Questions and Discussions + url: https://github.com/docker/build-push-action/discussions/new + about: Use Github Discussions to ask questions and/or open discussion topics. + - name: Documentation + url: https://docs.docker.com/build/ci/github-actions/ + about: Read the documentation. diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 0000000..6ab7568 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,15 @@ +# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema +name: Feature request +description: Missing functionality? Come tell us about it! +labels: + - kind/enhancement + - status/triage + +body: + - type: textarea + id: description + attributes: + label: Description + description: What is the feature you want to see? + validations: + required: true