- Ensure you have runners available
- Create a
- View the status of your pipeline and jobs
- Related topics
This tutorial shows you how to configure and run your first CI/CD pipeline in GitLab.
Before you start, make sure you have:
- A project in GitLab that you would like to use CI/CD for.
- The Maintainer or Owner role for the project.
If you don’t have a project, you can create a public project for free on https://gitlab.com.
To create and run your first pipeline:
Ensure you have runners available to run your jobs.
If you’re using GitLab.com, you can skip this step. GitLab.com provides shared runners for you.
.gitlab-ci.ymlfile at the root of your repository. This file is where you define the CI/CD jobs.
When you commit the file to your repository, the runner runs your jobs. The job results are displayed in a pipeline.
In GitLab, runners are agents that run your CI/CD jobs.
To view available runners:
- Go to Settings > CI/CD and expand Runners.
As long as you have at least one runner that’s active, with a green circle next to it, you have a runner available to process your jobs.
If you don’t have a runner:
- Install GitLab Runner on your local machine.
Register the runner for your project.
When your CI/CD jobs run, in a later step, they will run on your local machine.
Now create a
.gitlab-ci.yml file. It is a YAML file where
you specify instructions for GitLab CI/CD.
In this file, you define:
- The structure and order of jobs that the runner should execute.
- The decisions the runner should make when specific conditions are encountered.
To create a
- On the left sidebar, select Repository > Files.
Above the file list, select the branch you want to commit to. If you’re not sure, leave
main. Then select the plus icon () and New file:
For the Filename, type
.gitlab-ci.ymland in the larger window, paste this sample code:
build-job: stage: build script: - echo "Hello, $GITLAB_USER_LOGIN!" test-job1: stage: test script: - echo "This job tests something" test-job2: stage: test script: - echo "This job tests something, but takes more time than test-job1." - echo "After the echo commands complete, it runs the sleep command for 20 seconds" - echo "which simulates a test that runs 20 seconds longer than test-job1" - sleep 20 deploy-prod: stage: deploy script: - echo "This job deploys something from the $CI_COMMIT_BRANCH branch." environment: production
This example shows four jobs:
deploy-prod. The comments listed in the
echocommands are displayed in the UI when you view the jobs. The values for the predefined variables
$CI_COMMIT_BRANCHare populated when the jobs run.
- Select Commit changes.
The pipeline starts and runs the jobs you defined in the
Now take a look at your pipeline and the jobs within.
Go to CI/CD > Pipelines. A pipeline with three stages should be displayed:
View a visual representation of your pipeline by selecting the pipeline ID:
View details of a job by selecting the job name. For example,
You have successfully created your first CI/CD pipeline in GitLab. Congratulations!
Now you can get started customizing your
.gitlab-ci.yml and defining more advanced jobs.
Here are some tips to get started working with the
For the complete
.gitlab-ci.yml syntax, see the full
.gitlab-ci.yml keyword reference.
- Use the pipeline editor to edit your
- Each job contains a script section and belongs to a stage:
- You can set additional configuration to customize how your jobs and stages perform:
- Use the
ruleskeyword to specify when to run or skip jobs. The
exceptlegacy keywords are still supported, but can’t be used with
rulesin the same job.
- Keep information across jobs and stages persistent in a pipeline with
artifacts. These keywords are ways to store dependencies and job output, even when using ephemeral runners for each job.
- Use the
defaultkeyword to specify additional configurations that are applied to all jobs. This keyword is often used to define
after_scriptsections that should run on every job.
- Use the
- Follow this guide to migrate from CircleCI.
- Follow this guide to migrate from Jenkins.
- Watch First time GitLab & CI/CD. This includes a quick introduction to GitLab, the first steps with CI/CD, building a Go project, running tests, using the CI/CD pipeline editor, detecting secrets and security vulnerabilities and offers more exercises for asynchronous practice.
- Watch Intro to GitLab CI. This workshop uses the Web IDE to quickly get going with building source code using CI/CD, and run unit tests.