2. Continuous Integration#

The Codebase is on github.

CI is currently done via github action. It is integrated to the following destinations:

The table below shows the details:

CI convention for branches#

Branch

Performs Tests?

Artifacts

DockerHub Tag

Push DockerHub Readme?

PyPI Version

Readthedocs Version

master

Yes

Pytest report.

latest

Yes

N/A

latest

feature/**

Yes

N/A

N/A

No

N/A

N/A

release/{major.minor}

Yes

N/A

N/A

No

N/A

N/A

CI convention for tags#

Tag

Performs Tests?

Artifacts

DockerHub Tag

Push DockerHub Readme?

PyPI Version

Readthedocs Version

release/{major.minor.patch}

Yes

Pytest artifacts + executables in github releases.

release-{major.minor.patch}

No

{majoir.minor.patch}

release-major.minor.patch