Skip to content

Commit

Permalink
Update README.rst (#164)
Browse files Browse the repository at this point in the history
describe the workflow to trigger the test suite in psydac before merging a specific branch in sympde-master
  • Loading branch information
campospinto authored Jul 26, 2024
1 parent 73a5998 commit 62d154f
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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%
Expand Down

0 comments on commit 62d154f

Please sign in to comment.