Skip to content

Commit 162186a

Browse files
authored
Merge pull request #308 from lexming/temlates
add documentation about new collection of templates in EasyBuild 5.0
2 parents 8df90b2 + ff0590a commit 162186a

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

docs/easybuild-v5/enhancements.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Various significant enhancements are included in EasyBuild v5.0, including:
66

77
- [New function to run shell commands: `run_shell_cmd`][run_shell_cmd]
88
- [Interactive debugging of failing shell commands via `env.sh` and `cmd.sh` scripts][interactive-debugging-failing-shell-commands]
9+
- [New collection of easyconfig templates][collection-easyconfig-templates]
910
- [Don't raise error when required extensions are not found when installing extensions in parallel][parallel-extensions-install]
1011
- [Mark support for installing extensions in parallel as stable (no longer experimental)][parallel-extensions-install-stable]
1112
- [Mark easystack support as stable (no longer experimental)][easystack-stable]
@@ -37,6 +38,27 @@ See [dedicated page](../interactive-debugging-failing-shell-commands.md).
3738

3839
---
3940

41+
## New collection of easyconfig templates {: #collection-easyconfig-templates}
42+
43+
The veteran `TEMPLATE.eb` is replaced in EasyBuild 5.0 with a much larger
44+
[collection of easyconfig templates](https://github.com/easybuilders/easybuild-easyconfigs/tree/main/contrib/easyconfig-templates)
45+
for commonly used package archetypes.
46+
47+
These templates are designed to be used as starting points for the development
48+
of new easyconfigs. Some are minimal with basic functionality and others are
49+
more complete and complex. All of them will help you save time by providing the
50+
structure of the easyconfig and several basic requirements already filled in.
51+
52+
The templates are located in the `contrib` folder of easyconfigs repository,
53+
aside from regular easyconfigs. They are organized in folders per toolchain
54+
generation. All of them are already adapted to the requirements of their
55+
generation, including the versions of toolchains and dependencies for instance.
56+
57+
If you would like to see other types of easyconfigs added as templates, please
58+
[open an issue or pull request with your suggestion][contributing].
59+
60+
---
61+
4062
## Granular exit codes { : #granular-exit-codes }
4163

4264
EasyBuild v5 now uses a range of ~50 exit codes instead of just 0 for normal

docs/easybuild-v5/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ Various significant enhancements are included in EasyBuild v5.0, including:
6767

6868
- [New function to run shell commands: `run_shell_cmd`](run_shell_cmd.md)
6969
- [Interactive debugging of failing shell commands via `env.sh` and `cmd.sh` scripts](../interactive-debugging-failing-shell-commands.md)
70+
- [New collection of easyconfig templates](enhancements.md#collection-easyconfig-templates)
7071
- [Don't raise error when required extensions are not found when installing extensions in parallel](enhancements.md#parallel-extensions-install)
7172
- [Mark support for installing extensions in parallel as stable (no longer experimental)](enhancements.md#parallel-extensions-install-stable)
7273
- [Mark easystack support as stable (no longer experimental)](enhancements.md#easystack-stable)

0 commit comments

Comments
 (0)