Skip to content
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

Jump to bottom

document download_instructions enhancements in EasyBuild 5.0 #243

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from
Open

document download_instructions enhancements in EasyBuild 5.0 #243

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
262078e
`download_instructions`
branfosj Feb 21, 2024
f75761f
clarification
branfosj Mar 4, 2024
cc075d6
Update docs/easybuild-v5/enhancements.md
branfosj Mar 13, 2024
7edd896
Merge branch 'develop' into download
branfosj Mar 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 14 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 @@ -7,6 +7,7 @@ Various significant enhancements are included in EasyBuild v5.0, including:
* [`run_shell_cmd` function][run_shell_cmd]
* [Enable RPATH linking by default][rpath]
* [Enable `--trace` by default][trace]
* [Require `download_instructions` to be specified][require_download_instructions]

---

Expand Down Expand Up @@ -57,3 +58,16 @@ To disable trace output, either:
[override]
trace=0
```

---

## Require `download_instructions` to be specified {: require_download_instructions }

[`download_instructions`][download_instructions] is used in easyconfigs to specify instructions, or information, on
how to obtain sources that are not directly downloadable. In EasyBuild 5, we've updated the testsuite for the `easybuild-easyconfigs`
repository to require that all easyconfig PR specify these (see [easybuild-easyconfigs PR #19881](https://github.com/easybuilders/easybuild-easyconfigs/pull/19881)).
branfosj marked this conversation as resolved.
Show resolved Hide resolved

As part of this enhancement we also added `download_instructions` to all easyconfigs that require them (see the PRs linked from
[easybuild-easyconfigs PR #19881](https://github.com/easybuilders/easybuild-easyconfigs/pull/19881)). In addition to the
`download_instructions` we also clearly specify the active source path (see
[easybuild-framework PR #4459](https://github.com/easybuilders/easybuild-framework/pull/4459)).
2 changes: 1 addition & 1 deletion docs/writing-easyconfig-files.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -471,7 +471,7 @@ sources = [{
in favour of the Python dictionary format described above; see also
[Specifying source files as 2-element tuples to provide a custom extraction command][depr_sources_2_element_tuple].

#### Using `download_instructions` for user-side part of installation
#### Using `download_instructions` for user-side part of installation {: download_instructions }

In some cases, getting some of the files required for an installation
cannot be automated. Reasons for this include:
Expand Down