cicd.rst

Continuous Integration
======================
The Continuous Integration is based on Jenkins.
A push to git repository will trigger a build for the package on Jenkins platform.
Then an email with a build log and unit test coverage report will be delivered to
the relavant developer.

The build log includes several sections on

1. a check on versions of requirements
2. a check on installation of requirements
3. a check on installation of package
4. a check on import of interfaces (top_level_interface)
5. unit tests and coverage
6. Numpydoc validation of interfaces


An example of test summary is at the end of build log.
If all checks/tests/validations passed, you will see a section as below.

.. code-block::

    ===================== TEST SUMMARY =====================
    Test passed!
    Check requirements: 0
    Install requirements: 0
    Install package: 0
    Importability status: 0
    Unit test status: 0
    Numpydoc status: 0