Skip to content

Latest commit

 

History

History
55 lines (36 loc) · 1.69 KB

contributing_ci_tests.rst

File metadata and controls

55 lines (36 loc) · 1.69 KB

Continuous Integration (CI) Testing

The Iris GitHub repository is configured to run checks on the code automatically when a pull request is created, updated or merged against Iris master. The checks performed are:

  • testing_cla
  • testing_cirrus

SciTools CLA Checker

A bot that checks the user who created the pull request has signed the Contributor's License Agreement (CLA). For more information on this this please see https://scitools.org.uk/organisation.html#governance

Cirrus-CI

The unit and integration tests in Iris are an essential mechanism to ensure that the Iris code base is working as expected. developer_running_tests may be run manually but to ensure the checks are performed a continuous integration testing tool named cirrus-ci is used.

A cirrus-ci configuration file named .cirrus.yml is in the Iris repository which tells Cirrus-CI what commands to run. The commands include retrieving the Iris code base and associated test files using conda and then running the tests. cirrus-ci allows for a matrix of tests to be performed to ensure that all expected variations test successfully.

The cirrus-ci tests are run automatically against the Iris master repository when a pull request is submitted, updated or merged.

GitHub Checklist

An example snapshot from a successful GitHub pull request shows all tests passing:

image

If any CI checks fail, then the pull request is unlikely to be merged to the Iris target branch by a core developer.