Skip to content

Commit 9a39e2c

Browse files
crazy-maxcrazy-max
authored
Merge pull request moby#5672 from thompson-shaun/add-issue-templates
Replace legacy issue template with revised issue forms
2 parents 9472cdf + facc345 commit 9a39e2c

File tree

5 files changed

+118
-18
lines changed

5 files changed

+118
-18
lines changed

‎.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
name: Bug Report
2+
description: File a bug report.
3+
type: "bug"
4+
labels:
5+
- status/triage
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
**Thank you for taking the time to report a bug!**
11+
If this is a security issue please report it to the [Docker Security team](mailto:[email protected]), see [SECURITY.md](https://github.com/moby/buildkit/blob/master/.github/SECURITY.md) for more information.
12+
13+
- type: checkboxes
14+
attributes:
15+
label: Contributing guidelines and issue reporting guide
16+
description: |
17+
Please read the contributing guidelines and issue reporting guide before proceeding.
18+
options:
19+
- label: I've read the [contributing guidelines](https://github.com/moby/buildkit/blob/master/.github/CONTRIBUTING.md) and wholeheartedly agree. I've also read the [issue reporting guide](https://github.com/moby/buildkit/blob/master/.github/issue_reporting_guide.md).
20+
required: true
21+
22+
- type: checkboxes
23+
attributes:
24+
label: Well-formed report checklist
25+
description: |
26+
Make sure that your request fulfills all of the following requirements.
27+
If one requirement cannot be satisfied, explain in detail why.
28+
options:
29+
- label: I have found a bug that the documentation does not mention anything about my problem
30+
required: true
31+
- label: I have found a bug that there are no open or closed issues that are related to my problem
32+
required: true
33+
- label: I have provided version/information about my environment and done my best to provide a reproducer
34+
required: true
35+
36+
- type: textarea
37+
attributes:
38+
label: Description of bug
39+
description: |
40+
Please provide a description of the bug, reproduction steps and version information.
41+
42+
<details>
43+
<summary>How to collect version information</summary>
44+
45+
Using `buildctl` and `buildkitd` to get version information
46+
```bash
47+
buildctl --version && buildkitd version
48+
```
49+
50+
Using `docker` to get BuildKit information
51+
```bash
52+
docker buildx version && docker buildx inspect
53+
```
54+
55+
Add Docker Engine information (if available)
56+
```bash
57+
docker version && docker info
58+
```
59+
60+
</details>
61+
value: |
62+
## Bug description
63+
64+
A description of the bug, observed, and expected behaviour.
65+
66+
## Reproduction
67+
68+
Steps to reproduce the problem. If you are using `docker build` or `docker buildx build` providing the command as well as any input files will help analysis.
69+
70+
## Version information
71+
72+
```bash
73+
terminal_output
74+
```
75+
validations:
76+
required: true

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# 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
2+
blank_issues_enabled: true
3+
contact_links:
4+
- name: Security and Vulnerabilities
5+
url: https://github.com/moby/buildkit/blob/master/.github/SECURITY.md
6+
about: Please report any security issues or vulnerabilities responsibly to the Docker security team. Please do not use the public issue tracker.
7+
- name: Questions and Discussions
8+
url: https://github.com/moby/buildkit/discussions/new
9+
about: Use Github Discussions to ask questions and/or open discussion topics.
10+
- name: Documentation
11+
url: https://github.com/moby/buildkit/tree/master/docs
12+
about: Read the documentation.
13+
- name: Join the Docker Community on Slack
14+
url: http://dockr.ly/comm-slack
15+
about: Join the Docker Community on Slack and head to the buildkit channel.

‎.github/ISSUE_TEMPLATE/feature.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: Feature or enhancement request
2+
description: Missing functionality? Come tell us about it!
3+
type: "enhancement"
4+
labels:
5+
- status/triage
6+
7+
body:
8+
- type: textarea
9+
id: description
10+
attributes:
11+
label: Description
12+
description: What is the feature you want to see?
13+
validations:
14+
required: true

‎.github/issue_reporting_guide.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# Issue reporting guide
22

3-
* [Security issues](#security-issues)
4-
* [Search for an existing issue](#search-for-an-existing-issue)
5-
* [Reproducible test case](#reproducible-test-case)
6-
* [Describe your environment](#describe-your-environment)
7-
* [Reporting deadlock](#reporting-deadlock)
8-
* [Reporting panics/error returns](#reporting-panicserror-returns)
9-
* [Gathering more debugging data](#gathering-more-debugging-data)
10-
* [Regressions](#regressions)
11-
* [Debugging issues that only reproduce in the live environment](#debugging-issues-that-only-reproduce-in-the-live-environment)
12-
* [Follow the progress of your issue](#follow-the-progress-of-your-issue)
13-
* [Try fixing your issue yourself](#try-fixing-your-issue-yourself)
14-
* [Additional reading](#additional-reading)
3+
- [Security issues](#security-issues)
4+
- [Search for an existing issue](#search-for-an-existing-issue)
5+
- [Reproducible test case](#reproducible-test-case)
6+
- [Describe your environment](#describe-your-environment)
7+
- [Reporting deadlock](#reporting-deadlock)
8+
- [Reporting panics/error returns](#reporting-panicserror-returns)
9+
- [Gathering more debugging data](#gathering-more-debugging-data)
10+
- [Regressions](#regressions)
11+
- [Debugging issues that only reproduce in the live environment](#debugging-issues-that-only-reproduce-in-the-live-environment)
12+
- [Follow the progress of your issue](#follow-the-progress-of-your-issue)
13+
- [Try fixing your issue yourself](#try-fixing-your-issue-yourself)
14+
- [Additional reading](#additional-reading)
1515

1616
## Security issues
1717

@@ -57,7 +57,7 @@ Sometimes it is not completely clear if the issue belongs in `moby/buildkit` , `
5757

5858
Provide versions of the tools you used:
5959

60-
- Using Buildkitd/Buildctl `buildctl --version` `buildkitd version`
60+
- Using Buildkitd/Buildctl `buildctl --version` and `buildkitd version`
6161
- Using Docker Buildx `docker buildx version` and `docker buildx inspect` to return info about your current builder instance. If you run `docker build` then also report this.
6262
- If the issue is specific to Docker Engine embedded BuildKit or `docker buildx` Docker driver then report `docker version` and `docker info`
6363

‎.github/issue_template.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

0 commit comments

Comments
 (0)