Skip to content

Commit

Permalink
fixes #201: update docs for CI/CD providers (#291)
Browse files Browse the repository at this point in the history
* fixes #201: update testing providers

* review comments
  • Loading branch information
jandom authored Sep 16, 2023
1 parent cff03fd commit 65a0281
Showing 1 changed file with 22 additions and 12 deletions.
34 changes: 22 additions & 12 deletions doc/source/testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -115,26 +115,36 @@ Ideally, you want all tests to pass. This will look like:

.. image:: images/ci_checks_passed.png

.. _appveyor:
.. _github-actions:

--------
Appveyor
--------
--------------
GitHub Actions
--------------

Configured in `.github/` directory. Uses YAML syntax to define both workflows and actions. See `GitHub Actions documentation <https://help.github.com/en/actions>`_ for more information.


.. _azure:

-----
Azure
-----

`AppVeyor`_ is a continuous integration/continuous deployment service. MDAnalysis uses it for `testing builds on Windows`_.
Configured in `azure-pipelines.yml` file. Uses YAML syntax to define Azure Pipelines tasks. See `Azure Pipelines documentation <https://docs.microsoft.com/en-us/azure/devops/pipelines/yaml-schema?view=azure-devops&tabs=schema>`_ for more information.

Builds are configured in the file ``.appveyor.yml``. If you add a new dependency to MDAnalysis, you will need to add it to the ``$CONDA_DEPENDENCIES`` or ``$PIP_DEPENDENCIES`` in ``.appveyor.yml`` to pass tests.

.. _`testing builds on Windows`: https://ci.appveyor.com/project/orbeckst/mdanalysis
.. _cirrus:

---------
Cirrus CI
---------

.. _travis:
The file `.cirrus.star` tells the provider what to do, it uses the Starlark syntax in YAML to define tasks. See `Cirrus CI documentation <https://cirrus-ci.org/guide/writing-tasks/>`_ for more information.

------
Travis
------
The actual files defining the workflows are in:

`Travis is a continuous integration service <https://travis-ci.com/MDAnalysis/mdanalysis>`_ for Linux and MacOS. MDAnalysis uses it for exhaustive testing on Linux systems, and some testing on MacOS. If you add a new dependency to MDAnalysis, you will need to add it to the ``$CONDA_DEPENDENCIES`` or ``$PIP_DEPENDENCIES`` in ``.travis.yml`` to pass tests.
- maintainer/ci/cirrus-ci.yml
- maintainer/ci/cirrus-deploy.yml


.. _codecov:
Expand Down

0 comments on commit 65a0281

Please sign in to comment.