Skip to content

Commit

Permalink
chore: github form templates
Browse files Browse the repository at this point in the history
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
  • Loading branch information
crazy-max committed Aug 16, 2023
1 parent 56932de commit c7907b3
Show file tree
Hide file tree
Showing 4 changed files with 129 additions and 37 deletions.
105 changes: 105 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
# 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 please read the [Troubleshooting doc](https://github.com/docker/build-push-action/blob/master/TROUBLESHOOTING.md).
- type: checkboxes
attributes:
label: Contributing guidelines
description: >
Please 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 checked that ...
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: >
Please provide a brief description of the bug in 1-2 sentences.
validations:
required: true

- type: textarea
attributes:
label: Expected behaviour
description: >
Please describe precisely what you'd expect to happen.
validations:
required: true

- type: textarea
attributes:
label: Actual behaviour
description: >
Please describe precisely what is actually happening.
validations:
required: true

- type: input
attributes:
label: Repository URL
description: >
Please provide the URL of the repository where you are experiencing the
issue. If your repository is private please provide a link to a minimal
repository that reproduces the issue. If you are not able to share any
of the above please provide your YAML workflow (asked below) and
make sure to remove any sensitive information.
- type: input
attributes:
label: Workflow run URL
description: >
Same as above but for the workflow run URL. If you are not able to
share any of the above please provide at least the logs of the workflow
run URL (asked below) and make sure to remove any sensitive information.
- type: textarea
attributes:
label: YAML workflow
description: >
Please provide the YAML workflow and make sure to remove any sensitive
information (if applicable).
render: yaml
validations:
required: true

- type: textarea
attributes:
label: Workflow logs
description: >
Please [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 (if applicable).
- type: textarea
attributes:
label: BuildKit logs
description: >
If applicable, please 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: |
Please provide any additional information that could be useful.
37 changes: 0 additions & 37 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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.
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit c7907b3

Please sign in to comment.