GitLab Runner
This is the repository of the official GitLab Runner written in Go. It runs tests and sends the results to GitLab. GitLab CI is the open-source continuous integration service included with GitLab that coordinates the testing.
Contributing
The official repository for this project is on GitLab.com.
Requirements
None: GitLab Runner is run as a single binary.
This project is designed for the Linux, OS X and Windows operating systems.
If you want to use Docker make sure that you have 1.5.0 at least installed.
Features
- Allows to run:
- multiple jobs concurrently
- use multiple tokens with multiple server (even per-project)
- limit number of concurrent jobs per-token
- Jobs can be run:
- locally
- using Docker container
- using Docker container and executing job over SSH
- using Docker container with autoscaling on different clouds and virtualization hypervisors
- connecting to remote SSH server
- Is written in Go and distributed as single binary without any other requirements
- Supports Bash, Windows Batch and Windows PowerShell
- Works on Ubuntu, Debian, OS X and Windows (and anywhere you can run Docker)
- Allows to customize job running environment
- Automatic configuration reload without restart
- Easy to use setup with support for docker, docker-ssh, parallels or ssh running environments
- Enables caching of Docker containers
- Easy installation as service for Linux, OSX and Windows
Compatibility chart
Supported features by different executors:
| Executor | Shell | Docker | Docker-SSH | VirtualBox | Parallels | SSH |
|---|---|---|---|---|---|---|
| Secure Variables | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| GitLab Runner Exec command | ✓ | ✓ | ✓ | no | no | no |
| gitlab-ci.yml: image | no | ✓ | ✓ | no | no | no |
| gitlab-ci.yml: services | no | ✓ | ✓ | no | no | no |
| gitlab-ci.yml: cache | ✓ | ✓ | no | no | no | no |
| gitlab-ci.yml: artifacts | ✓ | ✓ | no | no | no | no |
| Absolute paths: caching, artifacts | no | no | no | no | no | no |
| Passing artifacts between stages | ✓ | ✓ | no | no | no | no |
Supported systems by different shells:
| Shells | Bash | Windows Batch | PowerShell |
|---|---|---|---|
| Windows | ✓ | ✓ (default) | ✓ |
| Linux | ✓ (default) | no | no |
| OSX | ✓ (default) | no | no |
| FreeBSD | ✓ (default) | no | no |
Install GitLab Runner
- Install using GitLab's repository for Debian/Ubuntu/CentOS/RedHat (preferred)
- Install on OSX (preferred)
- Install on Windows (preferred)
- Install as Docker Service
- Install in Auto-scaling mode
- Use on FreeBSD
Use GitLab Runner
Select executor
Troubleshooting
Advanced Configuration
- Auto-scaling
- Install Bleeding Edge (development)
- Manual installation (advanced)
- See details about the shells
- See advanced configuration options
- See security considerations
Extra projects?
If you want to add another project, token or image simply RE-RUN SETUP. You don't have to re-run the runner. It will automatically reload configuration once it changes.
Changelog
Visit Changelog to view recent changes.
Version 0.5.0
Version 0.5.0 introduces many security related changes.
One of such changes is the different location of config.toml.
Previously (prior 0.5.0) config was read from current working directory.
Currently, when gitlab-runner is executed by root or with sudo config is read from /etc/gitlab-runner/config.toml.
If gitlab-runner is executed by non-root user, the config is read from $HOME/.gitlab-runner/config.toml.
However, this doesn't apply to Windows where config is still read from current working directory, but this most likely will change in future.
The config file is automatically migrated when GitLab Runner was installed from GitLab's repository. For manual installations the config needs to be moved by hand.
The future
- Please see the GitLab Direction page.
- Feel free submit issues with feature proposals on the issue tracker.
Author
License
This code is distributed under the MIT license, see the LICENSE file.