Add PR templates for adding and rebuilding software #1474
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| <!-- Pull Request Template for adding software – EESSI Software Layer --> | ||
| <!-- (comments look like this, beginning with what is at the start of this line | ||
| 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) | ||
|
|
||
| ## Description | ||
| <!-- | ||
| Give some context for the changes introduced by this PR | ||
| - What is the software being added? | ||
| - What domain does it serve? | ||
| - Why are you adding it? | ||
| - ... | ||
| --> | ||
|
|
||
| ## Target File(s) | ||
| <!-- | ||
| Confirm that this PR modifies the correct file(s) | ||
| For new software, the typical path format is: | ||
| - `easystacks/software.eessi.io/<EESSI version>/eessi-<EESSI version>-eb-<EasyBuild version>-<toolchain>.yml` | ||
| Example: | ||
| - `easystacks/software.eessi.io/2025.06/eessi-2025.06-eb-5.3.0-2025a.yml` | ||
| --> | ||
|
|
||
|
|
||
| Please verify: | ||
|
|
||
| <!-- Mark relevant options with an [x] --> | ||
| - [ ] I am targeting the [**correct EESSI version**](https://www.eessi.io/docs/repositories/versions/) | ||
| (e.g. `2025.06` for toolchain generation `2025a`, `2023.06` for toolchain generation `2023b`) | ||
| - [ ] I am using the [**latest EasyBuild version**](https://pypi.org/project/easybuild/) (e.g. `5.3.0`) | ||
| - [ ] I selected the **correct toolchain generation** (e.g. `2025a`) | ||
| - [ ] I did **not** modify other unrelated files | ||
|
|
||
| <!-- | ||
| ### Toolchain Notes | ||
| - The toolchain suffix (e.g. `2025a`) defines the compiler/MPI stack. | ||
| - See documentation: https://docs.easybuild.io/common-toolchains/ | ||
| Sometimes it can be difficult to figure out which suffix your software belongs to, if in doubt please ask for help on | ||
| the [EESSI slack](https://join.slack.com/t/eessi-hpc/shared_invite/zt-2wg10p26d-m_CnRB89xQq3zk9qxf1k3g) | ||
| --> | ||
|
|
||
| ## Type of Change | ||
| <!-- Mark relevant options with an [x] --> | ||
| - [ ] New software addition | ||
| - [ ] Version update | ||
| - [ ] Other (please specify): | ||
|
|
||
| ## Testing | ||
| <!-- Describe how you validated your changes --> | ||
| - [ ] I have tested this PR locally using [**EESSI-extend**](https://www.eessi.io/docs/using_eessi/building_on_eessi/#using-the-eessi-extend-module) | ||
| <!-- Hint: | ||
| module load EESSI/<EESSI version> | ||
| module load EESSI-extend | ||
| # Show what will be built | ||
| eb --missing --easystack <path to easystack> | ||
| # Perform the build | ||
| eb --robot --easystack <path to easystack> | ||
| --> | ||
| - [ ] The build completed successfully | ||
| - [ ] The installed software/module loads correctly | ||
| - [ ] Basic functionality has been verified | ||
|
Contributor
There was a problem hiding this comment. give example, like
Member
Author
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) |
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| <!-- Pull Request Template for rebuilding software – EESSI Software Layer --> | ||
| <!-- (comments look like this, beginning with what is at the start of this line | ||
| and ending with what is at the end of this one, so they can be multiline!) --> | ||
|
|
||
| ## Description of rebuild PR | ||
| <!-- | ||
| Give some context for the changes introduced by this PR | ||
| - Why is the rebuild necessary? | ||
| - What are the potential positive/negative impacts? | ||
| - ... | ||
| --> | ||
|
|
||
| ## Target File(s) | ||
| <!-- | ||
| Confirm that this PR modifies the correct file(s) | ||
| Rebuilds must be placed under the `rebuilds/` subdirectory: | ||
| - `easystacks/software.eessi.io/<EESSI version>/rebuilds/<date>-eb-<EasyBuild version>-<description>.yml` | ||
| Example: | ||
| - `easystacks/software.eessi.io/2025.06/rebuilds/20260413-eb-5.3.0-RStudio-r_home-patch.yml` | ||
| --> | ||
|
|
||
| Please verify: | ||
|
|
||
| <!-- Mark relevant options with an [x] --> | ||
| - [ ] This is a rebuild (not a standard addition/update) | ||
| - [ ] I am targeting the [**correct EESSI version**](https://www.eessi.io/docs/repositories/versions/) | ||
| (e.g. `2025.06` for toolchain generation `2025a`, `2023.06` for toolchain generation `2023b`) | ||
| - [ ] The file is placed in the correct `rebuilds/` directory | ||
| - [ ] I am using the [**latest EasyBuild version**](https://pypi.org/project/easybuild/) (e.g. `5.3.0`) | ||
| - [ ] The filename gives some indication of the reason for the rebuild | ||
| - [ ] The file includes comments explaining **exactly why the rebuild is necessary** | ||
| - [ ] I did **not** modify other unrelated files | ||
|
|
||
| ## Testing | ||
| <!-- Describe how you validated your changes --> | ||
| <!-- Mark relevant options with an [x] --> | ||
| - [ ] I have tested this PR locally using [**EESSI-extend**](https://www.eessi.io/docs/using_eessi/building_on_eessi/#using-the-eessi-extend-module) | ||
| <!-- Hint: | ||
| module load EESSI/<EESSI version> | ||
| module load EESSI-extend | ||
| # Show what will be rebuilt | ||
| eb --missing --rebuild --easystack <path to easystack> | ||
| # Perform the build (no dependencies are to be built, so no `--robot`) | ||
| eb --rebuild --easystack <path to easystack> | ||
| --> | ||
| - [ ] The build completed successfully | ||
| - [ ] The installed software/module loads correctly | ||
| - [ ] Basic functionality has been verified |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| PULL_REQUEST_TEMPLATE/add_software.md | ||
|
Member
Author
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
Member
Author
There was a problem hiding this comment. Turns out this is a long-standing issue: https://github.com/orgs/community/discussions/4620#discussioncomment-16483888 |
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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)