[pull] develop from easybuilders:develop

.github/workflows/check_with_codespell.sh

@@ -1 +1 @@
-codespell --skip='.git,version-specific,scripts' --ignore-words-list=atleast,ninjs,simpy,proovread --quiet-level=2; retVal=$?; if [ $retVal -eq 1 ]; then echo 'Got one expected warning, so success!';  else $(exit $retVal); fi;
+codespell --skip='.git,version-specific,scripts,logo' --ignore-words-list=atleast,ninjs,simpy,proovread,namd,precice --quiet-level=2; retVal=$?; if [ $retVal -eq 1 ]; then echo 'Got one expected warning, so success!';  else $(exit $retVal); fi;

.github/workflows/doc_build.yml

@@ -2,11 +2,13 @@ name: Docs build and installation end-to-end tests
 
 on: [push, pull_request]
 
-jobs:
-  build:
+concurrency:
+  group: ${{format('{0}:{1}:{2}', github.repository, github.ref, github.workflow)}}
+  cancel-in-progress: true
 
+jobs:
+  docs:
     runs-on: ubuntu-latest
-
     steps:
     - uses: actions/checkout@v2
     - name: Set up Python 3.8
@@ -30,7 +32,7 @@ jobs:
         bash .github/workflows/check_with_codespell.sh
     - name: Test with sphinx
       run: |
-        pip install sphinx
+        pip install -r docs/requirements.txt
         # This test is weak, options -nWT would make it stronger but we have many warnings...
         READTHEDOCS=1 sphinx-build docs build
     - name: Test installation

.github/workflows/linting.yml

@@ -0,0 +1,25 @@
+name: Static Analysis
+on: [push, pull_request]
+
+concurrency:
+  group: ${{format('{0}:{1}:{2}', github.repository, github.ref, github.workflow)}}
+  cancel-in-progress: true
+
+jobs:
+  python-linting:
+    runs-on: ubuntu-20.04
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3.8
+
+    - name: install Python packages
+      run: |
+        pip install --upgrade pip
+        pip install --upgrade flake8
+
+    - name: Run flake8 to verify PEP8-compliance of Python code
+      run: flake8 -j3

.github/workflows/scripts.yml

@@ -0,0 +1,151 @@
+name: Tests for scripts
+on: [push, pull_request]
+
+concurrency:
+  group: ${{format('{0}:{1}:{2}', github.repository, github.ref, github.workflow)}}
+  cancel-in-progress: true
+
+jobs:
+  scripts:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        repo: [easybuild-framework, easybuild-easyblocks, easybuild-easyconfigs, easybuild]
+      fail-fast: false
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.8
+    - name: install EasyBuild (framework-only)
+      run: |
+        pip install easybuild-framework
+        eb --version
+    - name: install modules tool
+      run: |
+        sudo apt-get install lua5.2 liblua5.2-dev lua-filesystem lua-posix tcl-dev
+        # fix for lua-posix packaging issue, see https://bugs.launchpad.net/ubuntu/+source/lua-posix/+bug/1752082
+        # needed for Ubuntu 18.04, but not for Ubuntu 20.04, so skipping symlinking if posix.so already exists
+        if [ ! -e /usr/lib/x86_64-linux-gnu/lua/5.2/posix.so ] ; then
+            sudo ln -s /usr/lib/x86_64-linux-gnu/lua/5.2/posix_c.so /usr/lib/x86_64-linux-gnu/lua/5.2/posix.so
+        fi
+        # use script provided by easybuild-framework to install recent Lmod
+        source install_eb_dep.sh Lmod-8.3.8 $HOME
+        echo $MOD_INIT > $HOME/mod_init
+        echo $PATH > $HOME/path
+    - name: clone repo
+      run: |
+        cd $HOME
+        git clone https://github.com/easybuilders/${{matrix.repo}}.git
+    - name: test create_source_tarball.sh script
+      run: |
+        source $(cat $HOME/mod_init); type module
+        export PATH=$(cat $HOME/path)
+
+        cd $HOME/${{matrix.repo}}
+        git checkout main
+
+        # file to figure out the version from depends on repo
+        if [[ ${{matrix.repo}} == "easybuild-framework" ]]; then
+            version_file=easybuild/tools/version.py
+        elif [[ ${{matrix.repo}} == "easybuild-easyblocks" ]]; then
+            version_file=easybuild/easyblocks/__init__.py
+        else
+            version_file=setup.py
+        fi
+        version=$(grep '^.*VERSION[ ]*=' $version_file | head -1 |sed 's/[^0-9]*\([0-9a-zA-Z.]*\).*/\1/g')
+        echo "${{matrix.repo}} version: $version"
+
+        echo "testing with '$GITHUB_WORKSPACE/scripts/create_source_tarball.sh ${{matrix.repo}} $version'"
+
+        out=$HOME/out.txt
+
+        echo "================================================================================================"
+
+        # check use of script outside correct directory
+        cd $HOME
+        ($GITHUB_WORKSPACE/scripts/create_source_tarball.sh ${{matrix.repo}} $version 2>&1 | tee $out) || true
+        grep "ERROR: Expected to be in ${{matrix.repo}} directory" $out
+        echo "Expected error found in output: OK!"
+
+        echo "================================================================================================"
+
+        cd ${{matrix.repo}}
+
+        # script should make sure we're on main branch
+        git checkout develop &> /dev/null
+        ($GITHUB_WORKSPACE/scripts/create_source_tarball.sh ${{matrix.repo}} $version 2>&1 | tee $out) || true
+        grep "ERROR: Not on main branch" $out
+        echo "Expected error found in output: OK!"
+        git checkout main &> /dev/null
+
+        echo "================================================================================================"
+
+        # specified version should match with current version
+        ($GITHUB_WORKSPACE/scripts/create_source_tarball.sh ${{matrix.repo}} 0.0.0 2>&1 | tee $out) || true
+        grep "ERROR: Found version '${version}'" $out
+        echo "Expected error found in output: OK!"
+
+        echo "================================================================================================"
+
+        # existing source tarball in dist should result in an error
+        mkdir -p dist
+        touch dist/${{matrix.repo}}-${version}.tar.gz
+        ($GITHUB_WORKSPACE/scripts/create_source_tarball.sh ${{matrix.repo}} $version 2>&1 | tee $out) || true
+        grep "ERROR: Found dist/${{matrix.repo}}-${version}.tar.gz" $out
+        echo "Expected error found in output: OK!"
+        rm dist/${{matrix.repo}}-${version}.tar.gz
+
+        echo "================================================================================================"
+
+        # check for error when script is run in a dirty working copy
+        touch dirty.txt
+        ($GITHUB_WORKSPACE/scripts/create_source_tarball.sh ${{matrix.repo}} $version 2>&1 | tee $out) || true
+        grep "ERROR: Working directory not clean" $out
+        echo "Expected error found in output: OK!"
+        rm dirty.txt
+
+        echo "================================================================================================"
+
+        # create fake 'python3' command:
+        # just exits when 1st argument is setup.py, but calls out to origin Python command otherwise;
+        # this is important w.r.t. the Python version checks run by the 'eb' script
+        mkdir -p /tmp/$USER/bin
+        export PATH=/tmp/$USER/bin:$PATH
+        echo '#!/bin/bash' > /tmp/$USER/bin/python3
+        chmod u+x /tmp/$USER/bin/python3
+        echo 'orig_python3=$(which -a python3 | head -2 | tail -1)' >> /tmp/$USER/bin/python3
+        echo 'if [[ "$1" == "setup.py" ]]; then exit 0; else $orig_python3 "$@"; fi' >> /tmp/$USER/bin/python3
+
+        # script should fail if expected source tarball did not get created in dist/
+        ($GITHUB_WORKSPACE/scripts/create_source_tarball.sh ${{matrix.repo}} $version 2>&1 | tee $out) || true
+        grep "ERROR: No source tarball for ${{matrix.repo}} ${version} found" $out
+        echo "Expected error found in output: OK!"
+
+        # clean up index file, to avoid check for dirty working directory failing
+        rm -f easybuild/easyconfigs/.eb-path-index
+
+        echo "================================================================================================"
+
+        # make fake python command fail if 1st argument is setup.py
+        sed -i 's/exit 0/exit 1/g' /tmp/$USER/bin/python3
+
+        # script should deal well with failing 'python3 setup.py sdist'
+        ($GITHUB_WORKSPACE/scripts/create_source_tarball.sh ${{matrix.repo}} $version 2>&1 | tee $out) || true
+        grep "ERROR: Creating source tarball failed" $out
+        echo "Expected error found in output: OK!"
+
+        # cleanup
+        rm -f /tmp/$USER/bin/python3 easybuild/easyconfigs/.eb-path-index
+
+        echo "================================================================================================"
+
+        # check use of script in correct way, should yield "SUCCESS" in output
+        $GITHUB_WORKSPACE/scripts/create_source_tarball.sh ${{matrix.repo}} $version 2>&1 | tee $out
+        egrep "SUCCESS|Source tarball for ${{matrix.repo}} ${version} is ready for publishing with" $out
+        # no errors in output
+        errors=$(grep ERROR $out || true)
+        if [ ! -z $errors ]; then "Errors found: $errors"; fi
+
+        echo "Correct run of script OK!"

.gitignore

@@ -5,5 +5,6 @@ LICENSE_HEADER
 *.swp
 *.nja
 build/
+/docs/_build/
 dist/
 *egg-info/

.readthedocs.yml

@@ -0,0 +1,21 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# version of configuration file (required)
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# also build docs in PDF format
+formats: [pdf]
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 3.7
+  install:
+      - method: pip
+        path: .
+      - requirements: docs/requirements.txt

README.rst

@@ -1,10 +1,11 @@
-.. image:: https://easybuilders.github.io/easybuild/images/easybuild_logo_small.png
+.. image:: https://github.com/easybuilders/easybuild/raw/develop/logo/png/easybuild_logo_2022_horizontal_dark_bg_transparent.png
    :align: center
+   :height: 400px
 
-.. image:: https://travis-ci.org/easybuilders/easybuild.svg?branch=develop
-    :target: https://travis-ci.org/easybuilders/easybuild
+.. image:: https://github.com/easybuilders/easybuild/actions/workflows/doc_build.yml/badge.svg
+    :target: https://github.com/easybuilders/easybuild/actions/workflows/doc_build.yml
 
-`EasyBuild <https://easybuilders.github.io/easybuild>`_ is a software build
+`EasyBuild <https://easybuild.io>`_ is a software build
 and installation framework that allows you to manage (scientific) software
 on High Performance Computing (HPC) systems in an efficient way.
 
@@ -28,24 +29,23 @@ Corresponding Python packages are available via PyPi:
 Documentation
 ~~~~~~~~~~~~~
 
-Read the fine manual (RTFM!) at http://easybuild.readthedocs.org .
+Read the fine manual (RTFM!) at http://docs.easybuild.io .
 
 Getting started
 ~~~~~~~~~~~~~~~
 
-The recommended way of installing EasyBuild is via the
-`documented bootstrap procedure <http://easybuild.readthedocs.org/en/latest/Installation.html#bootstrapping-procedure>`_
-You should `configure <http://easybuild.readthedocs.org/en/latest/Configuration.html>`_
+The recommended way of installing EasyBuild is `using pip <https://docs.easybuild.io/en/latest/Installation.html>`_.
+You should `configure <http://docs.easybuild.io/en/latest/Configuration.html>`_
 EasyBuild to behave as you prefer, subsequently.
 
 That is all that is needed to get started with installing (scientific) software with ease.
-Take a look at the `typical workflow <http://easybuild.readthedocs.org/en/latest/Typical_workflow_example_with_WRF.html>`_
+Take a look at the `typical workflow <http://docs.easybuild.io/en/latest/Typical_workflow_example_with_WRF.html>`_
 example in the EasyBuild documentation that shows how to make EasyBuild build and **install WRF with a single command**.
 
 Quick demo for the impatient
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-After `installing EasyBuild <http://easybuild.readthedocs.org/en/latest/Installation.html>`_,
+After `installing EasyBuild <http://docs.easybuild.io/en/latest/Installation.html>`_,
 you can build and install **HPL** on top of a compiler toolchain that consists of open source
 components (GCC, OpenMPI, etc.) by running the following commands::
 
@@ -59,7 +59,7 @@ This should install a module file for HPL which you can load to start using it::
   $ module load HPL
 
 For more information on using EasyBuild, see the
-`EasyBuild documentation <http://easybuild.readthedocs.org/>`_
+`EasyBuild documentation <http://docs.easybuild.io/>`_
 
 Contact info
 ~~~~~~~~~~~~
@@ -77,16 +77,11 @@ have any questions or suggestions, you can post them there.
 Only members can post to this mailinglist. To request membership, see
 https://lists.ugent.be/wws/info/easybuild.
 
-IRC
-^^^
+Slack
+^^^^^
 
-An IRC channel #easybuild has been set up on the FreeNode network.
-
-Just connect your IRC client to the irc.freenode.net server, and join
-the #easybuild channel.
-
-There is an IRC bot present (easybuilder). Just type !help to get
-pointers to the available commands.
+Contact the EasyBuild community via Slack: https://easybuild.slack.com,
+self-request an invite via https://easybuild.io/join-slack.
 
 Twitter
 ^^^^^^^