A simple python application for running a CI pipeline locally This app currently supports GitLab CI scripts
- Download the latest build from the releases section on the GitHub page
- Unzip the files
- Using the cmd or terminal of your machine, navigate to the folder and run
simpleLocalCI.exe
with the arguments as described below- E.g.
simpleLocalCI.exe -c testCIConfigFile.yaml -d textProject/src -rs True
- E.g.
When calling the local ci runner, the following arguments can be included
Argument | Description | Type | Required | Default |
---|---|---|---|---|
--baseDirectory (d ) |
The base directory to run the jobs in. | String | Y | N/A |
--config (-c ) |
The configuration file to run the jobs from. | String | Y | N/A |
--showErrors (-e ) |
Whether the errors should be shown. (sets requireSuccess param to be true also) | Boolean | N | False |
--timeout (-t ) |
The time, in seconds, before a job is timedout. | Int | N | 30 |
--onSuccess (-s ) |
The command to run on the success of all jobs. | String | N | N/A |
--onFailure (-f ) |
The command to run if at least one job fails. | String | N | N/A |
--noColour (-n ) |
Whether no colour should be shown in the logging messages. | Boolean | N | False |
--requireSuccess (-rs ) |
Whether the previous job must be a success to trigger the next job. | Boolean | N | False |
- Install the python dependencies in
requirements.txt
- Run the CI runner using
python3 main.py -d <directoryToTestIn> -c <configFile>
replacing the fields between<>
- Setup you local dev environment
- Run the
build.cmd
This software is released under the GNU AGPLv3 licence