act works now

Author: pancetta

.github/workflows/ci_pipeline.yml

@@ -19,10 +19,9 @@ jobs:
         run: |
           sudo apt-get update
           sudo apt-get --yes install texlive-latex-recommended texlive-fonts-recommended texlive-latex-extra cm-super dvipng nodejs
-          
+
       - name: Cache conda
         uses: actions/cache@v2
-#        if: ${{ !env.ACT }}
         env:
           # Increase this value to reset cache if etc/example-environment.yml has not changed
           CACHE_NUMBER: 2
@@ -31,14 +30,15 @@ jobs:
           key:
             ${{ runner.os }}-conda-${{ env.CACHE_NUMBER }}-${{ hashFiles('requirements.txt') }}
 
-      - name: Install miniconda
+      - name: act workarounds
         if: ${{ env.ACT }}
         run: |
           MINICONDA_URL="https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh"
           wget $MINICONDA_URL
           MINICONDA_SH="Miniconda3-latest-Linux-x86_64.sh"
           sudo bash $MINICONDA_SH -b -p $CONDA
           rm $MINICONDA_SH # Clean up after installing
+          mkdir data
 
       - uses: conda-incubator/setup-miniconda@v2
         with:
@@ -52,12 +52,12 @@ jobs:
       - name: Install dependencies
         run: |
           conda install --yes -c conda-forge --file requirements.txt
-          
+
       - name: Lint with flake8
         run: |
           conda install --yes -c conda-forge flake8 flake8-comprehensions flake8-bugbear
           flake8 pySDC
-          
+
       - name: Run pytest
         run: |
           conda install --yes -c conda-forge pytest-cov
@@ -71,7 +71,7 @@ jobs:
 
       - name: Deploy 🚀
         uses: JamesIves/[email protected]
-        if: ${{ github.event_name == 'push' }}
+        if: ${{ github.event_name == 'push' }} && ${{ !env.ACT }}
         with:
           branch: gh-pages # The branch the action should deploy to.
           folder: docs/build/html # The folder the action should deploy.

CHANGELOG.rst

@@ -1,8 +1,9 @@
 Changelog
 ---------
 
-- October 21, 2021: Version 4.2 brings compatibility with Python 3.9, including some code cleanup. The CI test suite seems to run
-  faster now, since sorting out the dependencies is faster.
+- October 21, 2021 (WIP): Version 4.2 brings compatibility with Python 3.9, including some code cleanup. The CI test
+  suite seems to run faster now, since sorting out the dependencies is faster. Tested `mamba <https://github.com/mamba-org/mamba>`_,
+  but this is not stable enough, yet. Also, the CI workflow can now run locally using `act <https://github.com/nektos/act>`_.
 
 - August 11, 2021: Version 4.1 has some more changes under the hood, most of them with no significant impact to users.
   The CI pipeline has been completely rewritten, porting the code to `Github Actions <https://github.com/features/actions>`_

README.rst

@@ -16,7 +16,7 @@ Features
 - Many different examples, collocation types, data types already implemented
 - Works with `PETSc <http://www.mcs.anl.gov/petsc/>`_ through `petsc4py <https://bitbucket.org/petsc/petsc4py>`_ , `FEniCS <https://fenicsproject.org/>`_ and `mpi4py-fft <https://mpi4py-fft.readthedocs.io/en/latest/>`_
 - Continuous integration via `Github Actions <https://github.com/Parallel-in-Time/pySDC/actions>`__
-- Fully compatible with 3.6 (or higher)
+- Fully compatible with Python 3.6 - 3.9
 
 
 Getting started
@@ -60,7 +60,15 @@ You can achieve this e.g. by
 
    conda install -c conda-forge mpich petsc4py mpi4py fenics
 
-Most of the code is tested automatically using `Github Actions <https://github.com/Parallel-in-Time/pySDC/actions>`__, so a working version of the installation process can always be found in the `ci_pipeline.yml <https://github.com/Parallel-in-Time/pySDC/blob/master/.github/workflows/ci_pipeline.yml>`_ file.
+Most of the code is tested automatically using `Github Actions <https://github.com/Parallel-in-Time/pySDC/actions>`__, so
+a working version of the installation process can always be found in the `ci_pipeline.yml <https://github.com/Parallel-in-Time/pySDC/blob/master/.github/workflows/ci_pipeline.yml>`_ file.
+This workflow can be run locally using `act <https://github.com/nektos/act>`_ by
+
+.. code-block:: bash
+
+   act --env CONDA=/usr/share/miniconda -j ci
+
+See also `here <https://github.com/lmmx/devnotes/wiki/Running-GitHub-CI-locally-with-nektos-act-(Docker)-in-LXC>`_ for details on how to run workflos depending on miniconda locally.
 
 For many examples, `LaTeX` is used for the plots, i.e. a decent installation of this is needed in order to run the tests.
 When using `fenics` or `petsc4py`, a C++ compiler is required (although installation may go through at first).