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.
yarn global add glciAt the root of your project (where your .gitlab-ci.yml is):
glci.glci to your .gitignore file to prevent committing it.
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 |
# ------------Changing the directory where glci keeps cache and artifacts between jobs. Defaults to .glci.
Removing the directory given to --dir (default to .glci) before running glci.
- If a
.envfile exists next to your.gitlab-ci.yml, variables inside it get automatically parsed and added to the containers - Most of the pre-defined environment variables normally set by GitLab CI are also set here: see pre-defined.js
It's pretty straightforward:
- it parses your
.gitlab-ci.ymlfile (and its "includes") - it runs each job of each stage (serially) in a Docker container created on the fly using the right image
- it logs the results in the console
- it shares the
cacheand theartifactsbetween jobs using Docker volumes - it automatically stops and removes the containers and the volumes created
- Handle glob in
cache:pathsandartifacts:paths(need to figure out how) - Handle
artifacts:untrackedandcache:untracked(need to figure out how) - Handle
artifacts:exclude(supports globs too) - Add
--envto allow defining / overriding env variables - Add
--in-vagrantto run docker in Vagrant (not faster even on Mac for what I've tried) - Prevent sharing artifacts between same-stage jobs