Add PR templates for adding and rebuilding software#1474
Conversation
| @@ -0,0 +1 @@ | |||
| PULL_REQUEST_TEMPLATE/add_software.md No newline at end of file | |||
There was a problem hiding this comment.
This creates a default template, without this you need to manually specify the template to use in your URL, like https://github.com/ocaisa/software-layer/compare/main...ocaisa:software-layer:dummy?template=rebuild_software.md
There was a problem hiding this comment.
Turns out this is a long-standing issue: https://github.com/orgs/community/discussions/4620#discussioncomment-16483888
| and ending with what is at the end of this one, so they can be multiline!) --> | ||
|
|
||
| (If you need a PR template for a rebuild, open the Preview tab in this comment | ||
| and [click here](?expand=1&template=rebuild_software.md). Otherwise delete this line) |
There was a problem hiding this comment.
This is a workaround for the fact that a PR template picker is not generally available (approach taken from https://github.com/orgs/community/discussions/4620#discussioncomment-3383383)
|
|
||
| <!-- Mark relevant options with an [x] --> | ||
| - [ ] I am targeting the **correct EESSI version** (e.g. `2025.06` for toolchain families `2025a`, `2023.06` for toolchain families `2023b`) | ||
| - [ ] I am using the **latest EasyBuild version** (e.g. `5.3.0`) |
| Please verify: | ||
|
|
||
| <!-- Mark relevant options with an [x] --> | ||
| - [ ] I am targeting the **correct EESSI version** (e.g. `2025.06` for toolchain families `2025a`, `2023.06` for toolchain families `2023b`) |
There was a problem hiding this comment.
add link to docs: https://www.eessi.io/docs/repositories/versions/
| <!-- Mark relevant options with an [x] --> | ||
| - [ ] I am targeting the **correct EESSI version** (e.g. `2025.06` for toolchain families `2025a`, `2023.06` for toolchain families `2023b`) | ||
| - [ ] I am using the **latest EasyBuild version** (e.g. `5.3.0`) | ||
| - [ ] I selected the **correct toolchain family** (e.g. `2025a`) |
| - [ ] I am targeting the **correct EESSI version** (e.g. `2025.06` for toolchain families `2025a`, `2023.06` for toolchain families `2023b`) | ||
| - [ ] I am using the **latest EasyBuild version** (e.g. `5.3.0`) | ||
| - [ ] I selected the **correct toolchain family** (e.g. `2025a`) | ||
| - [ ] I did **not** modify older or unrelated files |
|
|
||
| ## Testing | ||
| <!-- Describe how you validated your changes --> | ||
| - [ ] I have tested this PR locally using **EESSI-extend** |
| --> | ||
| - [ ] The build completed successfully | ||
| - [ ] The installed software/module loads correctly | ||
| - [ ] Basic functionality has been verified |
There was a problem hiding this comment.
give example, like example --help ?
There was a problem hiding this comment.
I don't want to make this too big, what this might mean is very software specific so I don't have a problem with being a little vague (ideally the easyconfig is doing such basic checks anyway)
|
@laraPPr Can you also take a look at this? |
|
We're doing a number of presentations this month about contributions, having this in place is helpful. We also need CI to check that they are targetting the right file. We probably want to make some of our CI conditional on labels being set. It's confusing for people to see failing CI, and we can avoid it. |
2 participants
This works in my testing on my own repo.