Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mdubourg001/glci
🦊 Test your Gitlab CI Pipelines changes locally using Docker.
https://github.com/mdubourg001/glci
ci docker gitlab gitlab-ci jobs pipelines
Last synced: about 15 hours ago
JSON representation
🦊 Test your Gitlab CI Pipelines changes locally using Docker.
- Host: GitHub
- URL: https://github.com/mdubourg001/glci
- Owner: mdubourg001
- Created: 2021-02-16T22:04:16.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-12-21T13:02:05.000Z (almost 3 years ago)
- Last Synced: 2024-10-30T02:37:32.771Z (about 2 months ago)
- Topics: ci, docker, gitlab, gitlab-ci, jobs, pipelines
- Language: JavaScript
- Homepage:
- Size: 500 KB
- Stars: 571
- Watchers: 12
- Forks: 16
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# glci 🦊
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.
## Installation
You need to have Docker installed and running to use glci.
```bash
yarn global add glci
```
## Usage
At the root of your project (where your `.gitlab-ci.yml` is):
```bash
glci
```
⚠️ You might want to add `.glci` to your `.gitignore` file to prevent committing it.
## Options
### `--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:
```bash
glci --only-jobs=install,test:e2e
# "build" and "test:unit" won't be ran here
#
# ----------- --------- -------------
# | install | --- | build | --- | test:unit |
# ----------- --------- | -------------
# |
# | ------------
# --- | test:e2e |
# ------------
```
### `--yml `
Setting the file to use in place of `.gitlab-ci.yml` (default to `.gitlab-ci.yml`). Useful when testing parent-child pipelines.
### `--dir `
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.
## Cool stuff
- If a `.env` file 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](/pre-defined.js)
## Pulling images from private registries / repositories
To 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`.
## How does it work ?
It's pretty straightforward:
- it parses your `.gitlab-ci.yml` file (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 `cache` and the `artifacts` between jobs using Docker volumes
- it automatically stops and removes the containers and the volumes created
## Roadmap
- Handle glob in `cache:paths` and `artifacts:paths`
- Handle `artifacts:exclude` (supports globs too)
- Add `--env` to allow defining / overriding env variables
- Add `--in-vagrant` to run docker in Vagrant (not faster even on Mac for what I've tried)
- Prevent sharing artifacts between same-stage jobs