🦊 Test your Gitlab CI Pipelines changes locally using Docker.
Ease GitLab CI Pipelines set-up by running your jobs locally in Docker containers.
Why ? Because I did not want to commit, push, and wait for my jobs to run on the GitLab UI to figure I forgot to install make
before running make build
.
📣 Disclaimer: this is a helper tool aiming to facilite the process of setting up GitLab CI Pipelines. glci does NOT aim to replace any other tool.
You need to have Docker installed and running to use glci.
yarn global add glci
At the root of your project (where your .gitlab-ci.yml
is):
glci
⚠️ You might want to add .glci
to your .gitignore
file to prevent committing it.
--only-jobs [jobs]
Limiting the jobs to run to the comma-separated list of jobs name given. Handy when setting up that stage-three job depending on that first-stage job artifacts.
Example:
glci --only-jobs=install,test:e2e
# "build" and "test:unit" won't be ran here
#
# ----------- --------- -------------
# | install | --- | build | --- | test:unit |
# ----------- --------- | -------------
# |
# | ------------
# --- | test:e2e |
# ------------
--yml <yml_file_path>
Setting the file to use in place of .gitlab-ci.yml
(default to .gitlab-ci.yml
). Useful when testing parent-child pipelines.
--dir <directory_name>
Changing the directory where glci keeps cache and artifacts between jobs. Defaults to .glci
.
--clean
Removing the directory given to --dir
(default to .glci
) before running glci.
--no-draw
Not drawing the representation of the pipeline before running jobs.
.env
file exists next to your .gitlab-ci.yml
, variables inside it get automatically parsed and added to the containersTo be able to pull images from private registries / repositories, glci copies a GitLab CI mechanism: the DOCKER_AUTH_CONFIG
env variable (see https://docs.gitlab.com/ee/ci/docker/using_docker_images.html#configuring-a-job).
As glci automatically reads the .env
file at the root of your project, you can set a DOCKER_AUTH_CONFIG
inside it as you would do it in GitLab CI/CD variables configurations and you should be able to pull images from your private registries.
Don't forget to add this .env
file to your .gitignore
.
It's pretty straightforward:
.gitlab-ci.yml
file (and its "includes")cache
and the artifacts
between jobs using Docker volumescache:paths
and artifacts:paths
artifacts:exclude
(supports globs too)--env
to allow defining / overriding env variables--in-vagrant
to run docker in Vagrant (not faster even on Mac for what I've tried)