-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
revise landing page with overview of changes in EasyBuild v5.0
- Loading branch information
Showing
17 changed files
with
178 additions
and
130 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains 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
This file contains 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
This file contains 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
This file contains 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 |
---|---|---|
@@ -1,13 +1,91 @@ | ||
# EasyBuild v5.0 | ||
|
||
A high-level overview of changes in EasyBuild version 5.0 is listed below. | ||
|
||
Click on a particular item for more information. | ||
|
||
!!! warning "EasyBuild version 5.0.0 is not released yet" | ||
|
||
EasyBuild v5.0.0 is still under active development via the `5.0.x` branches in the EasyBuild GitHub repositories. | ||
|
||
Shortly before the release of EasyBuild v5.0.0, the `5.0.x` branches will be collapsed in the corresponding | ||
`develop` branches, and the `5.0.x` branches will then only be used as a staging area for additional EasyBuild | ||
v5.0.x releases. | ||
|
||
The overview below is known to be incomplete, and will be gradually completed as we approach | ||
the release of EasyBuild v5.0.0. | ||
|
||
--- | ||
|
||
## Breaking changes {: #breaking-changes } | ||
|
||
EasyBuild v5.0 includes a number of backwards-incompatible changes: | ||
|
||
- [Python 3.6+ is required to run EasyBuild v5.0.0](python36-required.md) | ||
|
||
See also the [overview of removed functionality](#removed-functionality) below. | ||
Check failure on line 26 in docs/easybuild-v5/index.md GitHub Actions / buildLink fragments should be valid
|
||
|
||
|
||
--- | ||
|
||
## Changes in default configuration | ||
|
||
The default value for several EasyBuild configuration settings has been changed in EasyBuild v5.0: | ||
|
||
- [RPATH linking is enabled by default (`--rpath`)](changes-in-default-configuration.md#rpath) | ||
- [Trace output is enabled by default (`--trace`)](changes-in-default-configuration.md#trace) | ||
|
||
|
||
--- | ||
|
||
## Enhancements | ||
|
||
Various significant enhancements are included in EasyBuild v5.0, including: | ||
|
||
- [`run_shell_cmd` function](run_shell_cmd.md) | ||
- [Granular exit codes](enhancements.md#granular_exit_codes) | ||
- [Reproducible tarballs](enhancements.md#reproducible_tarballs) | ||
|
||
|
||
--- | ||
|
||
## Removed functionality {: #removed-functionality } | ||
|
||
Functionality that was deprecated a while ago has been removed: | ||
|
||
- [EasyBuild bootstrap script is removed](removed-functionality.md#bootstrap_script) | ||
- [Experimental support for `.yeb` easyconfig format is removed](removed-functionality.md#yeb) | ||
|
||
|
||
--- | ||
|
||
## Deprecated functionality {: #deprecated-functionality } | ||
|
||
Some functionality is being deprecated in EasyBuild v5.0, and will no longer be supported in EasyBuild v6.0: | ||
|
||
- [`run_cmd` and `run_cmd_qa` functions](deprecated-functionality.md#run_cmd) | ||
- [`easybuild.tools.py2vs3` module](deprecated-functionality.md#py2vs3) | ||
|
||
|
||
--- | ||
|
||
## Other changes | ||
|
||
*(coming soon)* | ||
|
||
|
||
--- | ||
|
||
## FAQ | ||
|
||
*(coming soon)* | ||
|
||
|
||
--- | ||
|
||
## Other links | ||
|
||
- [Beta releases and release candidates](release-candidates.md) | ||
- [Overview of changes](overview-of-changes.md) | ||
- [Backwards-incompatible changes](backwards-incompatible-changes.md) | ||
- [Changes in default configuration](changes-in-default-configuration.md) | ||
- [Enhancements](enhancements.md) | ||
- [`run_shell_cmd` function](run_shell_cmd.md) | ||
- [Deprecated functionality](deprecated-functionality.md) | ||
- [Policies](policies.md) | ||
- [GitHub Project board](https://github.com/orgs/easybuilders/projects/18) | ||
- [GitHub Project board for EasyBuild v5.0](https://github.com/orgs/easybuilders/projects/18) | ||
- [Talk on EasyBuild 5.0 at EasyBuild User Meeting 2023](https://easybuild.io/eum23/#easybuild5) | ||
- [Talk on EasyBuild 5.0 at EasyBuild User Meeting 2024](https://easybuild.io/eum24/#eb5) |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains 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,28 @@ | ||
# Python 3.6+ is required to run EasyBuild v5.0.0 | ||
|
||
EasyBuild 5.0 requires Python >= 3.6 to run. | ||
|
||
Running EasyBuild with Python 2.7 or a Python 3 version older than Python 3.6 is no longer supported. | ||
|
||
Trying to run EasyBuild with a Python version that is too old will result in an error: | ||
|
||
```log | ||
ERROR: No compatible 'python' command found via $PATH (EasyBuild requires Python 3.6+) | ||
``` | ||
|
||
Python 2.7 has been [end-of-life since 1 Jan 2020](https://www.python.org/doc/sunset-python-2), | ||
and dropping compatibility with Python 2.7 and Python 3.5 enabled some significant code cleanup | ||
(see [easybuild-framework PR #4229](https://github.com/easybuilders/easybuild-framework/pull/4229)). | ||
|
||
The [results of the 6th EasyBuild User Survey (2022)](https://easybuild.io/user_survey) show that the impact of | ||
this breaking change on the EasyBuild community should be very limited, since: | ||
|
||
- Only ~13% of survey participants were still running EasyBuild on top of Python 2.7; | ||
- No survey participants reported using Python 3.5; | ||
- Over 85% of survey participants reported using Python 3.6, or a more recent version of Python 3; | ||
- Only 3 out of 118 survey participants (~2.5%) reported that dropping support for running EasyBuild | ||
on top of Python 2 would be *problematic* for them; | ||
|
||
Along with actively removing code that was only required to retain compatibility with Python 2.7 or 3.5, | ||
the `easybuild.tools.py2vs3` module that was introduced to facilitate supporting both Python 2.7 and Python 3 | ||
has been deprecated (see also [here](deprecated-functionality.md#py2vs3)). |
This file contains 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,25 @@ | ||
# Removed functionality in EasyBuild v5.0 | ||
|
||
*(for a full overview of changes in EasyBuild v5.0, see [here](index.md))* | ||
|
||
Functionality that was deprecated a while ago has been removed: | ||
|
||
- [EasyBuild bootstrap script is removed][bootstrap_script] | ||
- [Experimental support for `.yeb` easyconfig format is removed][yeb] | ||
|
||
--- | ||
|
||
## Deprecated EasyBuild bootstrap script is removed {: #bootstrap_script } | ||
|
||
The EasyBuild bootstrap script has been removed (see [easybuild-framework PR #4233](https://github.com/easybuilders/easybuild-framework/pull/4233)). | ||
|
||
Please see the [installation page](../installation.md) for the suggested methods for installing EasyBuild. | ||
|
||
--- | ||
|
||
## Experimental support for `.yeb` easyconfig format is removed {: #yeb } | ||
|
||
Support for the experimental `.yeb` easyconfig format has been removed (see [easybuild-framework PR #4237](https://github.com/easybuilders/easybuild-framework/pull/4237)). | ||
|
||
This format allowed easyconfigs to be specified in YAML. However, there has been no recent development of this | ||
format and little suggestion that anyone was using it at all. |
This file contains 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
Oops, something went wrong.