diff --git a/doc/source/testing.rst b/doc/source/testing.rst index af148a3c9..14a129724 100644 --- a/doc/source/testing.rst +++ b/doc/source/testing.rst @@ -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 `_ 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 `_ 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 `_ for more information. ------- -Travis ------- +The actual files defining the workflows are in: -`Travis is a continuous integration service `_ 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: