Tired of pushing to test your .gitlab-ci.yml?
Run gitlab pipelines locally as shell executor or docker executor.
Get rid of all those dev specific shell scripts and make files.
build Known Vulnerabilities npm license Renovate
Quality Gate Status Maintainability Rating Reliability Rating Security Rating
Coverage Code Smells Duplicated Lines (%)
- Examples
- Installation
- Convenience
- Quirks
- Development
- Creating single executable binaries from source
Users of Debian-based distributions should prefer the the Deb822 format, installed with:
sudo wget -O /etc/apt/sources.list.d/gitlab-ci-local.sources https://gitlab-ci-local-ppa.firecow.dk/gitlab-ci-local.sources sudo apt-get update sudo apt-get install gitlab-ci-local
If your distribution does not support this, you can run these commands:
curl -s "https://gitlab-ci-local-ppa.firecow.dk/pubkey.gpg" | sudo apt-key add - echo "deb https://gitlab-ci-local-ppa.firecow.dk ./" | sudo tee /etc/apt/sources.list.d/gitlab-ci-local.list # OR # MUST be `.asc` at least for older apts (e.g. Ubuntu Focal), since the key is ASCII-armored PPA_KEY_PATH=/etc/apt/sources.list.d/gitlab-ci-local-ppa.asc curl -s "https://gitlab-ci-local-ppa.firecow.dk/pubkey.gpg" | sudo tee "${PPA_KEY_PATH}" echo "deb [ signed-by=${PPA_KEY_PATH} ] https://gitlab-ci-local-ppa.firecow.dk ./" | sudo tee /etc/apt/sources.list.d/gitlab-ci-local.list # and then sudo apt-get update sudo apt-get install gitlab-ci-local
Note that the path /etc/apt/sources.list.d/gitlab-ci-local.list is used in the file gitlab-ci-local.list.
If you change it in these commands you must also change it in /etc/apt/sources.list.d/gitlab-ci-local.list.
npm install -g gitlab-ci-local
bash version must be above or equal 4.x.x
brew install gitlab-ci-local
Download and put binary in C:\Program Files\Git\mingw64\bin
curl -L https://github.com/firecow/gitlab-ci-local/releases/latest/download/win.gz | gunzip -c > /c/Program\ Files/Git/mingw64/bin/gitlab-ci-local.exe
Executing gitlab-ci-local with --variable MSYS_NO_PATHCONV=1 can be useful in certain situations
Note
Most likely home-file-variables or project-file-variables is what you're looking for instead
All cli options can be assigned default values by either of the following ways:
export GCL_NEEDS=true # --needs options export GCL_FILE='.gitlab-ci-local.yml' # --file=.gitlab-ci-local.yml
# Either of the following: # - `.gitlab-ci-local-env` in the current working directory # - `$HOME/.gitlab-ci-local/.env` NEEDS=true # --needs FILE=doctor-strange.yml # --file=doctor-strange.yml
echo "alias gcl='gitlab-ci-local'" >> ~/.bashrc
gitlab-ci-local --completion >> ~/.bashrc
export GCL_TIMESTAMPS=true # or --timestamps: show timestamps in logs export GCL_MAX_JOB_NAME_PADDING=30 # or --maxJobNamePadding: limit padding around job name export GCL_QUIET=true # or --quiet: Suppress all job output
Sometimes there is the need of knowing which jobs will be added before actually executing the pipeline. GitLab CI Local is providing the ability of showing added jobs with the following cli flags.
The command gitlab-ci-local --list will return pretty output and will also filter all jobs which are set
to when: never.
name description stage when allow_failure needs
test-job Run Tests test on_success false
build-job build on_success true [test-job]
Same as --list but will also print out jobs which are set to when: never (directly and implicit e.g. via rules).
name description stage when allow_failure needs
test-job Run Tests test on_success false
build-job build on_success true [test-job]
deploy-job deploy never false [build-job]
The command gitlab-ci-local --list-csv will output the pipeline jobs as csv formatted list and will also filter all
jobs which are set
to when: never.
The description will always be wrapped in quotes (even if there is none) to prevent semicolons in the description
disturb the csv structure.
name;description;stage;when;allow_failure;needs
test-job;"Run Tests";test;on_success;false;[]
build-job;"";build;on_success;true;[test-job]
Same as --list-csv-all but will also print out jobs which are set to when: never (directly and implicit e.g. via
rules).
name;description;stage;when;allow_failure;needs
test-job;"Run Tests";test;on_success;false;[]
build-job;"";build;on_success;true;[test-job]
deploy-job;"";deploy;never;false;[build-job]
Untracked and ignored files will not be synced inside isolated jobs, only tracked files are synced.
Remember git add
local-only-job: rules: - { if: $GITLAB_CI == 'false' }
local-only-subsection: script: - if [ $GITLAB_CI == 'false' ]; then eslint . --fix; fi - eslint .
Put a file like this in $HOME/.gitlab-ci-local/variables.yml
--- project: gitlab.com/test-group/test-project.git: # Will be type Variable and only available if remote is exact match AUTHORIZATION_PASSWORD: djwqiod910321 gitlab.com:project/test-group/test-project.git: # another syntax AUTHORIZATION_PASSWORD: djwqiod910321 group: gitlab.com/test-group/: # Will be type Variable and only available for remotes that include group named 'test-group' DOCKER_LOGIN_PASSWORD: dij3213n123n12in3 global: # Will be type File, because value is a file path KNOWN_HOSTS: '~/.ssh/known_hosts' DEPLOY_ENV_SPECIFIC: type: variable # Optional and defaults to variable values: '*production*': 'Im production only value' 'staging': 'Im staging only value' FILE_CONTENT_IN_VALUES: type: file values: '*': | Im staging only value I'm great for certs n' stuff
Variables will now appear in your jobs, if project or group matches git remote, globals are always present
gitlab-ci-local --remote-variables git@gitlab.com:firecow/example.git=gitlab-variables.yml=master
The --variables-file [default: $CWD/.gitlab-ci-local-variables.yml] can be used to setup the CI/CD variables for the executors
--- AUTHORIZATION_PASSWORD: djwqiod910321 DOCKER_LOGIN_PASSWORD: dij3213n123n12in3 # Will be type File, because value is a file path KNOWN_HOSTS: '~/.ssh/known_hosts' # This is only supported in the yaml format # https://docs.gitlab.com/ee/ci/environments/index.html#limit-the-environment-scope-of-a-cicd-variable EXAMPLE: values: "*": "I am only available in all jobs" staging: "I am only available in jobs with `environment: staging`" production: "I am only available in jobs with `environment: production`"
AUTHORIZATION_PASSWORD=djwqiod910321
DOCKER_LOGIN_PASSWORD=dij3213n123n12in3
# NOTE: value will be '~/.ssh/known_hosts' which is different behavior from the yaml format
KNOWN_HOSTS='~/.ssh/known_hosts'
Adds descriptive text to gitlab-ci-local --list
# @Description Install npm packages npm-install: image: node artifacts: paths: - node_modules/ script: - npm install --no-audit
# @Interactive interactive-shell: rules: - if: $GITLAB_CI == 'false' when: manual script: - docker run -it debian bash
# @InjectSSHAgent need-ssh: image: kroniak/ssh-client script: - ssh-add -L
Prevent artifacts from being copied to source folder
# @NoArtifactsToSource produce: stage: build script: mkdir -p path/ && touch path/file1 artifacts: { paths: [ path/ ] }
A global configuration is possible when setting the following flag
gitlab-ci-local --no-artifacts-to-source
Includes from external sources are only fetched once and cached. Use --fetch-includes to ensure that the latest external sources are always fetched.
Shell executor jobs copies artifacts to host/cwd directory. Use --shell-isolation option to mimic correct artifact handling for shell jobs.
Docker executor copies artifacts to and from .gitlab-ci-local/artifacts
If your self-hosted GitLab instance uses custom ports, it is recommended to manually define the CI_SERVER_PORT and/or CI_SERVER_SHELL_SSH_PORT variables accordingly.
--- # $CWD/.gitlab-ci-local-variables.yml CI_SERVER_PORT: 8443 CI_SERVER_SHELL_SSH_PORT: 8022
GCL_PROJECT_DIR_ON_HOSTAbsolute path to gitlab-ci-local current working directory on the host machine. Use in docker-executor jobs only.
You need nodejs 18+
# Install node_modules npm install # Run all tests npm run test # Run the program with hot-reloading enabled using the `.gitlab-ci.yml` in the root directory npm run dev # Pass --help flag into the program npm run dev -- -- --help # (equivalent of gitlab-ci-local --help) # Run individual test-case npx jest tests/test-cases/cache-paths-not-array
It's also possible to run individual .gitlab-ci.yml, via npx tsx src/index.ts --cwd examples/docker-compose-nodejs
npm install npm run esbuild # According to your needs: npm run pkg-linux npm run pkg-win npm run pkg-macos npm run pkg-all # the binary will be generated in the respective ./bin/<os>/gitlab-ci-local