GitLab CI/CD Examples

This page contains links to a variety of examples that can help you understand how to implement GitLab CI/CD for your specific use case.

Examples are available in several forms. As a collection of:

.gitlab-ci.yml template files maintained in GitLab, for many common frameworks and programming languages.
Repositories with example projects for various languages. You can fork and adjust them to your own needs. Projects include an example of using Review Apps with a static site served by NGINX.
Examples and other resources listed below.

CI/CD examples

The following table lists examples with step-by-step tutorials that are contained in this section:

Use case	Resource
Browser performance testing	Browser Performance Testing with the Sitespeed.io container.
Clojure	Test a Clojure application with GitLab CI/CD.
Deployment with Dpl	Using `dpl` as deployment tool.
GitLab Pages	See the GitLab Pages documentation for a complete example of deploying a static site.
End-to-end testing	End-to-end testing with GitLab CI/CD and WebdriverIO.
Game development	DevOps and Game Dev with GitLab CI/CD.
Java with Maven	How to deploy Maven projects to Artifactory with GitLab CI/CD.
Java with Spring Boot	Deploy a Spring Boot application to Cloud Foundry with GitLab CI/CD.
Load performance testing	Load Performance Testing with the k6 container.
Multi project pipeline	Build, test deploy using multi project pipeline.
NPM with semantic-release	Publish NPM packages to the GitLab Package Registry using semantic-release.
PHP with Laravel, Envoy	Test and deploy Laravel applications with GitLab CI/CD and Envoy.
PHP with NPM, SCP	Running Composer and NPM scripts with deployment via SCP in GitLab CI/CD.
PHP with PHPunit, atoum	Testing PHP projects.
Parallel testing Ruby & JS	GitLab CI/CD parallel jobs testing for Ruby & JavaScript projects.
Python on Heroku	Test and deploy a Python application with GitLab CI/CD.
Ruby on Heroku	Test and deploy a Ruby application with GitLab CI/CD.
Scala on Heroku	Test and deploy a Scala application to Heroku.
Secrets management with Vault	Authenticating and Reading Secrets With Hashicorp Vault.

How to contributing examples

Contributions are welcome! You can help your favorite programming language users and GitLab by sending a merge request with a guide for that language.

CI/CD templates

Get started with GitLab CI/CD and your favorite programming language or framework by using a .gitlab-ci.yml template.

When you create a gitlab-ci.yml file in the UI, you can choose one of these templates:

If a programming language or framework template is not in this list, you can contribute one. To create a template, submit a merge request to https://gitlab.com/gitlab-org/gitlab/tree/master/lib/gitlab/ci/templates.

Adding templates to your GitLab installation (PREMIUM ONLY)

You can add custom examples and templates to your self-managed GitLab instance. Your GitLab administrator can designate an instance template repository that contains examples and templates specific to your organization.

Other resources

This section provides further resources to help you get familiar with various uses of GitLab CI/CD. Note that older articles and videos may not reflect the state of the latest GitLab release.

CI/CD in the cloud

For examples of setting up GitLab CI/CD for cloud-based environments, see:

Customer stories

For some customer experiences with GitLab CI/CD, see:

Getting started

For some examples to help get you started, see:

Implementing GitLab CI/CD

For examples of others who have implemented GitLab CI/CD, see:

Migrating to GitLab from third-party CI tools

Migrating from Jenkins to GitLab

Integrating GitLab CI/CD with other systems

To see how you can integrate GitLab CI/CD with third-party systems, see:

Mobile development

For help with using GitLab CI/CD for mobile application development, see: