summaryrefslogtreecommitdiff
path: root/.github/ISSUE_TEMPLATE/build_error.yml
diff options
context:
space:
mode:
authorgpotter2 <gabriel@potter.fr>2021-08-01 03:44:20 +0200
committerGitHub <noreply@github.com>2021-07-31 20:44:20 -0500
commitb1abfd3ff6c4d27b9baef7c7c036c7372fff1520 (patch)
treed604b159d9a2e74c1ef0b8e585fb4121c47fdf88 /.github/ISSUE_TEMPLATE/build_error.yml
parentb4c6c11e689b2292a1411e4fc60dcd49c929246d (diff)
downloadspack-b1abfd3ff6c4d27b9baef7c7c036c7372fff1520.tar.gz
spack-b1abfd3ff6c4d27b9baef7c7c036c7372fff1520.tar.bz2
spack-b1abfd3ff6c4d27b9baef7c7c036c7372fff1520.tar.xz
spack-b1abfd3ff6c4d27b9baef7c7c036c7372fff1520.zip
Use the new cool Github templates (#25118)
* Use the new cool github templates * Add the "mention maintainers" clause * Fix broken HTML tag * Minor improvements, missing filenames
Diffstat (limited to '.github/ISSUE_TEMPLATE/build_error.yml')
-rw-r--r--.github/ISSUE_TEMPLATE/build_error.yml64
1 files changed, 64 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/build_error.yml b/.github/ISSUE_TEMPLATE/build_error.yml
new file mode 100644
index 0000000000..cf5d867ffe
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/build_error.yml
@@ -0,0 +1,64 @@
+name: "\U0001F4A5 Build error"
+description: Some package in Spack didn't build correctly
+title: "Installation issue: "
+labels: [build-error]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thanks for taking the time to report this build failure. To proceed with the report please:
+ 1. Title the issue `Installation issue: <name-of-the-package>`.
+ 2. Provide the information required below.
+
+ We encourage you to try, as much as possible, to reduce your problem to the minimal example that still reproduces the issue. That would help us a lot in fixing it quickly and effectively!
+ - type: textarea
+ id: reproduce
+ attributes:
+ label: Steps to reproduce the issue
+ description: |
+ Fill in the exact spec you are trying to build and the relevant part of the error message
+ placeholder: |
+ ```console
+ $ spack install <spec>
+ ...
+ ```
+ validations:
+ required: true
+ - type: textarea
+ id: information
+ attributes:
+ label: Information on your system
+ description: Please include the output of `spack debug report`
+ validations:
+ required: true
+ - type: markdown
+ attributes:
+ value: |
+ If you have any relevant configuration detail (custom `packages.yaml` or `modules.yaml`, etc.) you can add that here as well.
+ - type: textarea
+ id: additional_information
+ attributes:
+ label: Additional information
+ description: |
+ Please upload the following files:
+ * **`spack-build-out.txt`**
+ * **`spack-build-env.txt`**
+
+ They should be present in the stage directory of the failing build. Also upload any `config.log` or similar file if one exists.
+ - type: markdown
+ attributes:
+ value: |
+ Some packages have maintainers who have volunteered to debug build failures. Run `spack maintainers <name-of-the-package>` and **@mention** them here if they exist.
+ - type: checkboxes
+ id: checks
+ attributes:
+ label: General information
+ options:
+ - label: I have run `spack debug report` and reported the version of Spack/Python/Platform
+ required: true
+ - label: I have run `spack maintainers <name-of-the-package>` and **@mentioned** any maintainers
+ required: true
+ - label: I have uploaded the build log and environment files
+ required: true
+ - label: I have searched the issues of this repo and believe this is not a duplicate
+ required: true