Merge pull request #299 from branfosj/fixes

use fixed commits for GitHub Actions workflows + various small fixes

Author: boegel

.github/workflows/deploy.yml

@@ -11,17 +11,17 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # 4.2.2
         with:
           fetch-depth: 0
 
       - name: set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38 # v5.4.0
         with:
           python-version: '3.10'
 
       - name: checkout easybuild framework
-        uses: actions/checkout@v3
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # 4.2.2
         with:
           repository: easybuilders/easybuild-framework
           path: src/easybuild-framework

.github/workflows/flake8.yml

@@ -8,12 +8,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # 4.2.2
 
       - name: set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38 # v5.4.0
         with:
           python-version: '3.10'
 
       - name: flake8 Lint
-        uses: py-actions/flake8@v2
+        uses: py-actions/flake8@84ec6726560b6d5bd68f2a5bed83d62b52bb50ba # v2.3.0

.github/workflows/markdown-linting.yml

@@ -9,10 +9,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # 4.2.2
 
       - name: MarkdownLint
-        uses: DavidAnson/markdownlint-cli2-action@v10
+        uses: DavidAnson/markdownlint-cli2-action@05f32210e84442804257b2a6f20b273450ec8265 # v19.1.0
         with:
           # all markdown, except filter out {demos,version-specific}/* for now, until we fix issues in those sections
           globs: |

.github/workflows/test.yml

@@ -9,17 +9,18 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # 4.2.2
+
         with:
           fetch-depth: 0
 
       - name: set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38 # v5.4.0
         with:
           python-version: '3.10'
 
       - name: Codespell action
-        uses: codespell-project/actions-codespell@master
+        uses: codespell-project/actions-codespell@406322ec52dd7b488e48c1c4b82e2a8b3a1bf630 # v2.1
         with:
           check_filenames: true
           ignore_words_list: atleast,ninjs,simpy,proovread,namd,precice,crate,ake
@@ -32,7 +33,7 @@ jobs:
         run: python ./.github/workflows/link_check.py
 
       - name: checkout easybuild framework
-        uses: actions/checkout@v3
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # 4.2.2
         with:
           repository: easybuilders/easybuild-framework
           path: src/easybuild-framework
@@ -43,7 +44,7 @@ jobs:
           pip install -r requirements.txt
           mkdocs --version
 
-      - name: build tutorial
+      - name: build docs
         # can't use --strict due to warnings being produced by mkdocs-redirect plugin
         # because we are re-directing .html pages
         # run: mkdocs build --strict

.github/workflows/yamllint.yml

@@ -7,8 +7,8 @@ jobs:
   lintAllTheThings:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # 4.2.2
       - name: yaml-lint
-        uses: ibiqlik/action-yamllint@v3
+        uses: ibiqlik/action-yamllint@2576378a8e339169678f9939646ee3ee325e845c # v3.1.1
         with:
           config_file: .yamllint.yml

docs/easybuild-v5/5.0.0beta1.md

@@ -37,7 +37,7 @@ This includes (but is not limited to):
 - **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
+## Installation {: #eb5.0.0beta1_installation }
 
 To install the initial beta release of EasyBuild v5.0.0 (`5.0.0beta1`), you can either:
 

docs/easybuild-v5/release-candidates.md

@@ -43,7 +43,7 @@ This includes (but is not limited to):
     - `parallel` easyconfig parameter (`maxparallel` easyconfig parameter or `parallel` property in easyblocks 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
+### Installation  {: #eb5.0.0beta2_installation }
 
 To install the 2nd beta release of EasyBuild v5.0.0 (`5.0.0beta2`), you can either:
 

docs/including-additional-python-modules.md

@@ -96,7 +96,7 @@ Since EasyBuild 4.2.0, easyblocks from a pull request on GitHub can also
 be included, using `--include-easyblocks-from-pr` (see
 [Using easyblocks from pull requests][github_include_easyblocks_from_pr]).
 
-### Example
+**Example**
 
 The example below shows how all self-implemented easyblocks (both
 software-specific and generic) located in the `$HOME/myeasyblocks`
@@ -123,7 +123,7 @@ path to the corresponding Python modules can be specified via
 To verify that EasyBuild is aware of the additional module naming
 schemes, the `--avail-module-naming-schemes` option can be used.
 
-### Example
+**Example**
 
 The example below shows how all custom module naming schemes located in
 the `$HOME/myebmns` can be included:
@@ -156,7 +156,8 @@ directory named according to the type of component (`compiler`, `mpi`,
 To verify that EasyBuild is aware of the included toolchains,
 `--list-toolchains` can be used.
 
-### Example
+
+**Example**
 
 The example below shows how the support for additional toolchains and
 the required additional compiler/MPI toolchain components implemented by

docs/index.md

@@ -30,7 +30,7 @@ To contribute to this documentation, [open a pull request](https://github.com/ea
 - List of [common toolchains](common-toolchains.md) and [supported software](version-specific/supported-software/index.md)
 - [Contributing to EasyBuild](contributing.md) | [GitHub integration features](integration-with-github.md)
 - [EasyBuild release notes](release-notes.md) | [EasyBuild v5.0](easybuild-v5/index.md)
-- For [end users](roles/end-users) | [user support](roles/user-support) | [contributors](roles/contributors) | [developers](roles/developers) | [maintainers](roles/maintainers)
+- For [end users](roles/end-users.md) | [user support](roles/user-support.md) | [contributors](roles/contributors.md) | [developers](roles/developers.md) | [maintainers](roles/maintainers.md)
 - [Getting help](getting-help.md): [mailing list](https://lists.ugent.be/wws/info/easybuild) - [Slack](https://easybuild.io/join-slack) - [conference calls](https://github.com/easybuilders/easybuild/wiki/Conference-calls) - [GitHub](https://github.com/easybuilders)
 
 ---

docs/integration-with-github.md

@@ -729,7 +729,7 @@ have in place already (cfr. [Specify location of working directories][github_git
     you *must* specify a (meaningful) commit message using
     `--pr-commit-msg`, see [Controlling pull request metadata][github_controlling_pr_metadata].
 
-#### Example
+**Example**
 
 For example, to create a pull request for a new version of, let's say,
 EasyBuild:
@@ -802,7 +802,7 @@ the repository, no changes are made to a possible existing working copy.
     When using `--update-pr` you *must* specify a (meaningful) commit message  
     via `--pr-commit-msg`, see [Controlling pull request metadata][github_controlling_pr_metadata].
 
-#### Example
+**Example**
 
 For example, to update pull request \#3153 with a changed easyconfig
 file: