From 439024bb17f04d4d12906ef7a311096d24dc0565 Mon Sep 17 00:00:00 2001 From: Martin Campos Pinto Date: Fri, 26 Jul 2024 08:36:25 +0200 Subject: [PATCH] Update README.rst describe PR workflow to also trigger the test suite of psydac --- README.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.rst b/README.rst index 9170ce5f..801c932d 100644 --- a/README.rst +++ b/README.rst @@ -39,6 +39,27 @@ From sources python3 -m pip install --user -e . +For developers +************** + +Because many important features of sympde are only tested in psydac, new PRs +must also be tested against the test suite of psydac. This can be done by opening +a PR in psydac where the only change consists of installing the corresponding +branch of sympde. + +For instance to test a new sympde branch called ``my_feature``, the following +lines can be used in the file ``.github/workflows/continuous-integration.yml`` of psydac: + +.. code-block:: YAML + + - name: Download a development version of sympde + working-directory: /tmp + run: | + wget https://github.com/pyccel/sympde/archive/refs/heads/my_feature.zip + unzip ./my_feature.zip + python3 -m pip install ./sympde-my_feature + + .. |build-status| image:: https://travis-ci.com/pyccel/sympde.svg?branch=master :alt: build status :scale: 100%