mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
bug_report issue form (#1966)
* Bring inline with ansible/ansible's issue template. * Add more placeholders
This commit is contained in:
John R Barker
GitHub
parent
ac95ff5b45
commit
e9866a2ccd
1 changed files with 113 additions and 72 deletions
185
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
185
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
|
|
@ -1,86 +1,127 @@
|
||||||
name: Bug Report
|
---
|
||||||
about: Create a report to help us improve
|
name: Bug report
|
||||||
|
description: Create a report to help us improve
|
||||||
|
issue_body: false # default: true, adds a classic WSYWIG textarea, if on
|
||||||
|
|
||||||
body:
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
⚠
|
||||||
|
Verify first that your issue is not [already reported on GitHub][issue search].
|
||||||
|
Also test if the latest release and devel branch are affected too.
|
||||||
|
*Complete **all** sections as described, this form is processed automatically.*
|
||||||
|
|
||||||
- type: markdown
|
[issue search]: https://github.com/ansible-collections/community.general/search?q=is%3Aissue&type=issues
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
Verify first that your issue is not already reported on [GitHub](https://github.com/ansible-collections/community.general/issues)
|
|
||||||
Also test if the latest release and main branch are affected too
|
|
||||||
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Summary
|
|
||||||
description: 'Explain the problem briefly below'
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
|
|
||||||
- type: dropdown
|
- type: textarea
|
||||||
attributes:
|
attributes:
|
||||||
# FIXME: Once GitHub allows defining the default choice, update this
|
label: Summary
|
||||||
label: Issue Type
|
description: Explain the problem briefly below.
|
||||||
options:
|
placeholder: >-
|
||||||
- Bug Report
|
When I try to do X with the collection from the main branch on GitHub, Y
|
||||||
validations:
|
breaks in a way Z under the env E. Here are all the details I know
|
||||||
required: true
|
about this problem...
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
- type: textarea
|
- type: dropdown
|
||||||
attributes:
|
attributes:
|
||||||
# For smaller collections we could use a multi-select and hardcode the list
|
label: Issue Type
|
||||||
# May generate this list via GitHub action and walking files under https://github.com/ansible-collections/community.general/tree/main/plugins
|
# FIXME: Once GitHub allows defining the default choice, update this
|
||||||
# Select from list, filter as you type (`mysql` would only show the 3 mysql components)
|
options:
|
||||||
# OR freeform - doesn't seem to be supported in adaptivecards
|
- Bug Report
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
label: Component Name
|
- type: textarea
|
||||||
description: 'List the component, ie `template`, `mysql_users`'
|
attributes:
|
||||||
validations:
|
# For smaller collections we could use a multi-select and hardcode the list
|
||||||
required: true
|
# May generate this list via GitHub action and walking files under https://github.com/ansible-collections/community.general/tree/main/plugins
|
||||||
|
# Select from list, filter as you type (`mysql` would only show the 3 mysql components)
|
||||||
|
# OR freeform - doesn't seem to be supported in adaptivecards
|
||||||
|
|
||||||
- type: textarea
|
description: >-
|
||||||
attributes:
|
Write the short name of the module, plugin, task or feature below,
|
||||||
label: Ansible Version
|
*use your best guess if unsure*.
|
||||||
description: |
|
placeholder: dnf, apt, yum, pip, user etc.
|
||||||
Paste verbatim output from `ansible --version` between quotes
|
validations:
|
||||||
value: |
|
required: true
|
||||||
```paste below
|
|
||||||
|
|
||||||
```
|
- type: textarea
|
||||||
- type: textarea
|
attributes:
|
||||||
attributes:
|
label: Ansible Version
|
||||||
label: Configuration
|
description: >-
|
||||||
description: |
|
Paste verbatim output from `ansible --version` between
|
||||||
If this issue has an example piece of YAML that can help to reproduce this problem, please provide it.
|
tripple backticks.
|
||||||
This can be a piece of YAML from, e.g., an automation, script, scene or configuration.
|
value: |
|
||||||
Paste verbatim output from `ansible-config dump --only-changed` between quotes
|
```console (paste below)
|
||||||
value: |
|
$ ansible --version
|
||||||
```paste below
|
|
||||||
|
|
||||||
```
|
```
|
||||||
- type: textarea
|
validations:
|
||||||
attributes:
|
required: true
|
||||||
label: OS / Environment
|
|
||||||
description: 'Provide all relevant information below, e.g. target OS versions, network device firmware, etc'
|
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
attributes:
|
attributes:
|
||||||
label: Steps To Reproduce
|
label: Configuration
|
||||||
description: 'Describe exactly how to reproduce the problem, using a minimal test-case'
|
description: >-
|
||||||
value: |
|
If this issue has an example piece of YAML that can help to reproduce this problem, please provide it.
|
||||||
```paste below
|
This can be a piece of YAML from, e.g., an automation, script, scene or configuration.
|
||||||
|
Paste verbatim output from `ansible-config dump --only-changed` between quotes
|
||||||
|
value: |
|
||||||
|
```console (paste below)
|
||||||
|
$ ansible-config dump --only-changed
|
||||||
|
|
||||||
```
|
```
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Expected Results
|
|
||||||
description: |
|
|
||||||
Describe what you expected to happen when running the steps above
|
|
||||||
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Actual Results
|
|
||||||
description: 'Describe what actually happened. If possible run with extra verbosity (`ansible-playbook -vvvv`)'
|
|
||||||
value: |
|
|
||||||
```paste below
|
|
||||||
|
|
||||||
```
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: OS / Environment
|
||||||
|
description: >-
|
||||||
|
Provide all relevant information below, e.g. target OS versions,
|
||||||
|
network device firmware, etc.
|
||||||
|
placeholder: RHEL 8, CentOS Stream etc.
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Steps to Reproduce
|
||||||
|
description: |
|
||||||
|
Describe exactly how to reproduce the problem, using a minimal test-case. It would *really* help us understand your problem if you could also pased any playbooks, configs and commands you used.
|
||||||
|
|
||||||
|
**HINT:** You can paste https://gist.github.com links for larger files.
|
||||||
|
value: |
|
||||||
|
<!--- Paste example playbooks or commands between quotes below -->
|
||||||
|
```yaml (paste below)
|
||||||
|
|
||||||
|
```
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Expected Results
|
||||||
|
description: >-
|
||||||
|
Describe what you expected to happen when running the steps above.
|
||||||
|
placeholder: >-
|
||||||
|
I expected X to happen because I assumed Y.
|
||||||
|
that it did not.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Actual Results
|
||||||
|
description: |
|
||||||
|
Describe what actually happened. If possible run with extra verbosity (`-vvvv`).
|
||||||
|
|
||||||
|
Paste verbatim command output between quotes.
|
||||||
|
value: |
|
||||||
|
```console (paste below)
|
||||||
|
|
||||||
|
```
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue