Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace legacy issue template with revised issue forms #5672

Merged
merged 1 commit into from
Jan 22, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 76 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
name: Bug Report
description: File a bug report.
type: "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:[email protected]), see [SECURITY.md](https://github.com/moby/buildkit/blob/master/.github/SECURITY.md) for more information.

- type: checkboxes
attributes:
label: Contributing guidelines and issue reporting guide
description: |
Please read the contributing guidelines and issue reporting guide before proceeding.
options:
- 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).
required: true

- type: checkboxes
attributes:
label: Well-formed report checklist
description: |
Make sure that your request fulfills all of the following requirements.
If one requirement cannot be satisfied, explain in detail why.
options:
- label: I have found a bug that the documentation does not mention anything about my problem
required: true
- label: I have found a bug that there are no open or closed issues that are related to my problem
required: true
- label: I have provided version/information about my environment and done my best to provide a reproducer
required: true

- type: textarea
attributes:
label: Description of bug
description: |
Please provide a description of the bug, reproduction steps and version information.

<details>
<summary>How to collect version information</summary>

Using `buildctl` and `buildkitd` to get version information
```bash
buildctl --version && buildkitd version
```

Using `docker` to get BuildKit information
```bash
docker buildx version && docker buildx inspect
```

Add Docker Engine information (if available)
```bash
docker version && docker info
```

</details>
value: |
## Bug description

A description of the bug, observed, and expected behaviour.

## Reproduction

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.

## Version information

```bash
terminal_output
```
validations:
required: true
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/config.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/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
blank_issues_enabled: true
contact_links:
- name: Security and Vulnerabilities
url: https://github.com/moby/buildkit/blob/master/.github/SECURITY.md
about: Please report any security issues or vulnerabilities responsibly to the Docker security team. Please do not use the public issue tracker.
- name: Questions and Discussions
url: https://github.com/moby/buildkit/discussions/new
about: Use Github Discussions to ask questions and/or open discussion topics.
- name: Documentation
url: https://github.com/moby/buildkit/tree/master/docs
about: Read the documentation.
- name: Join the Docker Community on Slack
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think in moby/moby we also added suggestions for reporting security issues (to make it more prominent that github is not the place for that)

https://github.com/moby/moby/blob/master/.github/ISSUE_TEMPLATE/config.yml#L3

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great suggestion! Adding.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@thompson-shaun Hum it seems we now have duplicated security blocks because of this: https://github.com/moby/buildkit/issues/new/choose

image

We should remove this one so only the dynamic one is shown, similar to what we have on Buildx repo: https://github.com/docker/buildx/issues/new/choose

image

url: http://dockr.ly/comm-slack
about: Join the Docker Community on Slack and head to the buildkit channel.
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Feature or enhancement request
description: Missing functionality? Come tell us about it!
type: "enhancement"
labels:
- status/triage

body:
- type: textarea
id: description
attributes:
label: Description
description: What is the feature you want to see?
validations:
required: true
26 changes: 13 additions & 13 deletions .github/issue_reporting_guide.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Issue reporting guide

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

## Security issues

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

Provide versions of the tools you used:

- Using Buildkitd/Buildctl `buildctl --version` `buildkitd version`
- Using Buildkitd/Buildctl `buildctl --version` and `buildkitd version`
- 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.
- If the issue is specific to Docker Engine embedded BuildKit or `docker buildx` Docker driver then report `docker version` and `docker info`

Expand Down
5 changes: 0 additions & 5 deletions .github/issue_template.md

This file was deleted.

Loading