From 9d9c86849f397795f970427543a24ffaf56ded1e Mon Sep 17 00:00:00 2001 From: Kenneth Hoste Date: Wed, 18 Dec 2024 13:43:55 +0100 Subject: [PATCH 1/5] add page on beta releases & release candidates for EasyBuild v5.0 --- docs/easybuild-v5/index.md | 2 + docs/easybuild-v5/release-candidates.md | 84 +++++++++++++++++++++++++ 2 files changed, 86 insertions(+) create mode 100644 docs/easybuild-v5/release-candidates.md diff --git a/docs/easybuild-v5/index.md b/docs/easybuild-v5/index.md index b1002acff..c7b05f915 100644 --- a/docs/easybuild-v5/index.md +++ b/docs/easybuild-v5/index.md @@ -1,5 +1,7 @@ # EasyBuild v5.0 + +- [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) diff --git a/docs/easybuild-v5/release-candidates.md b/docs/easybuild-v5/release-candidates.md new file mode 100644 index 000000000..d7d981479 --- /dev/null +++ b/docs/easybuild-v5/release-candidates.md @@ -0,0 +1,84 @@ +# Beta releases and release candidates for EasyBuild v5.0 + +Due to the large amount of changes in the upcoming EasyBuild v5.0 release, +we will tag a couple of beta releases and release candidates before releasing EasyBuild v5.0.0. + +**Please consider testing these and providing feedback!** + +## Beta release `5.0.0beta1` (18 Dec 2024) + +!!! warning + This is an early pre-release that includes the majority of changes that will be included + in EasyBuild v5.0.0. + + It can be used for testing and providing feedback (reporting bugs or unexpected behaviour, etc.). + + Additional changes will be made for the release of EasyBuild v5.0.0 however, [see below][beta1_planned_changes]. + +### Highlighted changes + +EasyBuild v5.0.0 will include some significant changes compared to EasyBuild v4.x that you should be aware of, including: + +- **Python >= 3.6** is required to run EasyBuild (Python >= 3.9 is recommended); +- using **Lmod >= v8.0** or **Environment Modules v4.3.0** is required as modules tool (check with `module --version`); +- a new function named `run_shell_cmd` is used to run shell commands like `cmake`, `make`, `pip`, etc. (more info [here](run_shell_cmd.md)); +- the **default settting of some configuration options has changed**: + - **RPATH linking** is used by default (can be disabled with `--disable-rpath`); + - **trace output** is enabled by default (can be disabled with `--disable-trace`); + - Lua module files generated by EasyBuild will use `depends_on` rather than `load` by default (can be disabled with `--disable-module-depends-on`); + - the `use_pip` and `sanity_pip_check` custom easyconfig parameters used by the `PythonPackage` and `PythonBundle` easyblocks are enabled by default; +- **some functionality has been deprecated**, including the use of the `run_cmd` and `run_cmd_qa` functions (`run_shell_cmd` should be used instead); +- easyconfigs using an old [unsupported toolchain](../policies/toolchains.md) have been moved to the [easyconfigs archive](https://github.com/easybuilders/easybuild-easyconfigs-archive); + +### Installation + +To install the initial beta release of EasyBuild v5.0.0 (`5.0.0beta1`), you can either: + +* use the [provided easyconfig file](https://github.com/easybuilders/easybuild-easyconfigs/pull/22049); +* install into a Python virtual environment: + ```shell + venv_name='venv-eb-5.0.0beta1' + python3 -m venv ${venv_name} + unset PYTHONPATH + source ${venv_name}/bin/activate + + tag='5.0.0beta1' + pip install https://github.com/easybuilders/easybuild-framework/archive/easybuild-framework-v${tag}.tar.gz + pip install https://github.com/easybuilders/easybuild-easyblocks/archive/easybuild-easyblocks-v${tag}.tar.gz + pip install https://github.com/easybuilders/easybuild-easyconfigs/archive/easybuild-easyconfigs-v${tag}.tar.gz + # optional dependencies for EasyBuild + pip install archspec rich + ``` + +### Planned additional changes {: #beta1_planned_changes } + +A couple of additional changes that will be included in EasyBuild v5.0.0 are still a work-in-progress, +including (but not limited to): + +- deprecating of `module_req_guess` method (see [framework PR #4653](https://github.com/easybuilders/easybuild-framework/pull/4653)); +- deprecating of `parallel` easyconfig parameter (see [framework PR #4580](https://github.com/easybuilders/easybuild-framework/pull/4580)); + +For a complete overview of planned changed, see the [GitHub dashboard for EasyBuild v5.0](https://github.com/orgs/easybuilders/projects/18/views/2). + +### Providing feedback & reporting problems + +Please test this release, provide feedback, and report problems, either via: + +- the `#eb5` channel in the EasyBuild Slack; +- the EasyBuild maling list; +- one of the upcoming [EasyBuild conf calls](https://github.com/easybuilders/easybuild/wiki/Conference-calls); +- the [dedicated issue in the `easybuild` repository](https://github.com/easybuilders/easybuild/issues/911); + +You should include: + +- the output produced by `eb --version`, `eb --show-config`, and `eb --show-system-info`; +- an overview of what you tried; +- whether it worked or not; +- which problems you ran into (if any); + +Also positive feedback is welcome! + +### FAQ + +- *Do I need to reinstall all software that was installed with EasyBuild v4.x when I want to start using EasyBuild v5.x?* + No, you do not. You can install additional software using EasyBuild v5.x on top of installations performed with EasyBuild v4.x. From ddd4aaafa90335cc253ff6c44dbd26189251d6ef Mon Sep 17 00:00:00 2001 From: Kenneth Hoste Date: Wed, 18 Dec 2024 14:30:29 +0100 Subject: [PATCH 2/5] fix markdown linting issues + minor enhancements to info on EasyBuild v5.0.0beta1 release --- docs/easybuild-v5/release-candidates.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/docs/easybuild-v5/release-candidates.md b/docs/easybuild-v5/release-candidates.md index d7d981479..625fe1531 100644 --- a/docs/easybuild-v5/release-candidates.md +++ b/docs/easybuild-v5/release-candidates.md @@ -13,11 +13,16 @@ we will tag a couple of beta releases and release candidates before releasing Ea It can be used for testing and providing feedback (reporting bugs or unexpected behaviour, etc.). - Additional changes will be made for the release of EasyBuild v5.0.0 however, [see below][beta1_planned_changes]. + Additional changes can still be made before the release of EasyBuild v5.0.0, [see below][beta1_planned_changes]. ### Highlighted changes -EasyBuild v5.0.0 will include some significant changes compared to EasyBuild v4.x that you should be aware of, including: +EasyBuild v5.0.0 will include some significant changes compared to EasyBuild v4.x. + +Some of those changes are internal improvements and will be invisible to most users, but many others may need special attention +as they incorporate new features, changes of behavior or deprecations that can impact your workflow. + +This includes (but is not limited to): - **Python >= 3.6** is required to run EasyBuild (Python >= 3.9 is recommended); - using **Lmod >= v8.0** or **Environment Modules v4.3.0** is required as modules tool (check with `module --version`); @@ -25,7 +30,10 @@ EasyBuild v5.0.0 will include some significant changes compared to EasyBuild v4. - the **default settting of some configuration options has changed**: - **RPATH linking** is used by default (can be disabled with `--disable-rpath`); - **trace output** is enabled by default (can be disabled with `--disable-trace`); - - Lua module files generated by EasyBuild will use `depends_on` rather than `load` by default (can be disabled with `--disable-module-depends-on`); + - Lua module files generated by EasyBuild will by default: + - use `depends_on` rather than `load` (can be disabled with `--disable-module-depends-on`); + - include an `extensions` statement to expose the list of included extensions (can be disabled with `--disable-module-extensions`); + - reproducible creation of source tarballs from Git repositories via `git_config` in `sources` easyconfig parameter (when using Python >= 3.9); - the `use_pip` and `sanity_pip_check` custom easyconfig parameters used by the `PythonPackage` and `PythonBundle` easyblocks are enabled by default; - **some functionality has been deprecated**, including the use of the `run_cmd` and `run_cmd_qa` functions (`run_shell_cmd` should be used instead); - easyconfigs using an old [unsupported toolchain](../policies/toolchains.md) have been moved to the [easyconfigs archive](https://github.com/easybuilders/easybuild-easyconfigs-archive); @@ -34,8 +42,9 @@ EasyBuild v5.0.0 will include some significant changes compared to EasyBuild v4. To install the initial beta release of EasyBuild v5.0.0 (`5.0.0beta1`), you can either: -* use the [provided easyconfig file](https://github.com/easybuilders/easybuild-easyconfigs/pull/22049); -* install into a Python virtual environment: +- use the [provided easyconfig file](https://github.com/easybuilders/easybuild-easyconfigs/pull/22049); +- install into a Python virtual environment: + ```shell venv_name='venv-eb-5.0.0beta1' python3 -m venv ${venv_name} From abf1cd67e2e522963dae6f2ed72a50e66b0c391f Mon Sep 17 00:00:00 2001 From: Kenneth Hoste Date: Wed, 18 Dec 2024 14:42:26 +0100 Subject: [PATCH 3/5] fix typo --- docs/easybuild-v5/release-candidates.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/easybuild-v5/release-candidates.md b/docs/easybuild-v5/release-candidates.md index 625fe1531..5ce1bca91 100644 --- a/docs/easybuild-v5/release-candidates.md +++ b/docs/easybuild-v5/release-candidates.md @@ -27,7 +27,7 @@ This includes (but is not limited to): - **Python >= 3.6** is required to run EasyBuild (Python >= 3.9 is recommended); - using **Lmod >= v8.0** or **Environment Modules v4.3.0** is required as modules tool (check with `module --version`); - a new function named `run_shell_cmd` is used to run shell commands like `cmake`, `make`, `pip`, etc. (more info [here](run_shell_cmd.md)); -- the **default settting of some configuration options has changed**: +- the **default setting of some configuration options has changed**: - **RPATH linking** is used by default (can be disabled with `--disable-rpath`); - **trace output** is enabled by default (can be disabled with `--disable-trace`); - Lua module files generated by EasyBuild will by default: From a392cc3e7e4542cfcb0b97e6a00914599c325266 Mon Sep 17 00:00:00 2001 From: Kenneth Hoste Date: Thu, 19 Dec 2024 09:04:38 +0100 Subject: [PATCH 4/5] fix release date for EasyBuild v5.0.0beta1 --- docs/easybuild-v5/release-candidates.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/easybuild-v5/release-candidates.md b/docs/easybuild-v5/release-candidates.md index 5ce1bca91..8abf24e9e 100644 --- a/docs/easybuild-v5/release-candidates.md +++ b/docs/easybuild-v5/release-candidates.md @@ -5,7 +5,7 @@ we will tag a couple of beta releases and release candidates before releasing Ea **Please consider testing these and providing feedback!** -## Beta release `5.0.0beta1` (18 Dec 2024) +## Beta release `5.0.0beta1` (19 Dec 2024) !!! warning This is an early pre-release that includes the majority of changes that will be included From 88d61eec1682d1df18ba203314b518aa492e39ce Mon Sep 17 00:00:00 2001 From: Kenneth Hoste Date: Tue, 24 Dec 2024 17:08:34 +0100 Subject: [PATCH 5/5] fix release date for EasyBuild v5.0.0beta1 to 24 Dec'24 --- docs/easybuild-v5/release-candidates.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/easybuild-v5/release-candidates.md b/docs/easybuild-v5/release-candidates.md index 8abf24e9e..d906a69c3 100644 --- a/docs/easybuild-v5/release-candidates.md +++ b/docs/easybuild-v5/release-candidates.md @@ -5,7 +5,7 @@ we will tag a couple of beta releases and release candidates before releasing Ea **Please consider testing these and providing feedback!** -## Beta release `5.0.0beta1` (19 Dec 2024) +## Beta release `5.0.0beta1` (24 Dec 2024) !!! warning This is an early pre-release that includes the majority of changes that will be included