Skip to content

add documentation about new collection of templates in EasyBuild 5.0 #308

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
branfosj merged 2 commits into from
Mar 19, 2025
Merged

add documentation about new collection of templates in EasyBuild 5.0 #308

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4da7900
add documentation about new collection of templates in EasyBuild 5.0
lexming Mar 19, 2025
ff0590a
fix link to section about new template collection
lexming Mar 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/easybuild-v5/enhancements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Various significant enhancements are included in EasyBuild v5.0, including:

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

---

## New collection of easyconfig templates {: #collection-easyconfig-templates}

The veteran `TEMPLATE.eb` is replaced in EasyBuild 5.0 with a much larger
[collection of easyconfig templates](https://github.com/easybuilders/easybuild-easyconfigs/tree/main/contrib/easyconfig-templates)
for commonly used package archetypes.

These templates are designed to be used as starting points for the development
of new easyconfigs. Some are minimal with basic functionality and others are
more complete and complex. All of them will help you save time by providing the
structure of the easyconfig and several basic requirements already filled in.

The templates are located in the `contrib` folder of easyconfigs repository,
aside from regular easyconfigs. They are organized in folders per toolchain
generation. All of them are already adapted to the requirements of their
generation, including the versions of toolchains and dependencies for instance.

If you would like to see other types of easyconfigs added as templates, please
[open an issue or pull request with your suggestion][contributing].

---

## Granular exit codes { : #granular-exit-codes }

EasyBuild v5 now uses a range of ~50 exit codes instead of just 0 for normal
Expand Down
1 change: 1 addition & 0 deletions docs/easybuild-v5/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ Various significant enhancements are included in EasyBuild v5.0, including:

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