Skip to content

Commit

Permalink
fix markdown linting issues + minor enhancements to info on EasyBuild…
Browse files Browse the repository at this point in the history
… v5.0.0beta1 release
  • Loading branch information
boegel committed Dec 18, 2024
1 parent 9d9c868 commit ddd4aaa
Showing 1 changed file with 14 additions and 5 deletions.
19 changes: 14 additions & 5 deletions docs/easybuild-v5/release-candidates.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,27 @@ 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`);
- 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**:

Check failure on line 30 in docs/easybuild-v5/release-candidates.md

View workflow job for this annotation

GitHub Actions / build

settting ==> setting
- **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);
Expand All @@ -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}
Expand Down

0 comments on commit ddd4aaa

Please sign in to comment.