- Preparing a build environment
See Preparing a Build Environment page for instructions on how to prepare build environment using Docker.
You create a platform-specific package using the
$ bin/omnibus build gitlab
The platform/architecture type of the package created will match the platform
build project command is invoked. So running this command on say a
MacBook Pro will generate a Mac OS X specific package. After the build
completes packages will be available in
You can clean up all temporary files generated during the build process with
$ bin/omnibus clean
--purge purge option removes ALL files generated during the
build including the project install directory (
the package cache directory (
$ bin/omnibus clean --purge
Full help for the Omnibus command line interface can be accessed with the
$ bin/omnibus help
# Build with stable packagecloud packages # This will build gitlab-ee (8.0.2-ee.1) using STABLE repo and tag it as gitlab-ee:latest make docker_build RELEASE_VERSION=8.0.2-ee.1 PACKAGECLOUD_REPO=gitlab-ee RELEASE_PACKAGE=gitlab-ee # Build with unstable packagecloud packages # This will build gitlab-ce (8.0.2-ce.1) using UNSTABLE repo and tag it as gitlab-ce:latest make docker_build RELEASE_VERSION=8.0.2-ce.1 PACKAGECLOUD_REPO=unstable RELEASE_PACKAGE=gitlab-ce
# This will push gitlab-ee:latest as gitlab/gitlab-ee:8.0.2-ee.1 make docker_push RELEASE_PACKAGE=gitlab-ee RELEASE_VERSION=8.0.2-ee.1 # This will push gitlab-ce:latest as gitlab/gitlab-ce:8.0.2-ce.1 make docker_push RELEASE_PACKAGE=gitlab-ce RELEASE_VERSION=8.0.2-ce.1 # This will push gitlab-ce:latest as gitlab/gitlab-ce:latest make docker_push_latest RELEASE_PACKAGE=gitlab-ce
Note For a description on how the official omnibus-gitlab package is built, see the release process document.
If you are working on implementing a feature in one of the GitLab components, you might need to build a package from your custom branch in order to test the feature using the omnibus-gitlab package.
For example, you've implemented something inside of GitLab Rails application and
the code is located in the branch named
To use the custom branch for building an omnibus-gitlab package, you will need
to put the branch name in
VERSION file inside of omnibus-gitlab repository.
The same works for specifying commits also. If you want to build a package that will use a specific commit, you have to place the SHA of that commit in the VERSION file.
For example, if you want to build a package that will use a branch named
VERSION file in omnibus-repo should contain the text
my-feature-branch. Similary, if you want to build a package that will use
a specific commit, say this one,
VERSION file should contain the text
which is the SHA of that commit.
Similarly, you can do the same for
GITLAB_WORKHORSE_VERSION and so on.
Note: Name of this custom branch should not match the format of a SemVer
version, that is
xx.yy.zz. This is because omnibus-gitlab will append a
before the branch name, mistaking it for a version tag. Example, branch name
can not be
0.5.0 as omnibus-gitlab will automatically make it
To build a GitLab EE package, set the environment variable
ee to true (run
$ export ee=true) before starting the build. It will make
omnibus-gitlab pull the EE repo instead of CE one and build an EE package.
If you are a member of the GitLab Inc. team, you will have access to the build infrastructure (or to the colleagues that have access to the infrastructure).
You can easily build custom packages leveraging the build infrastructure to test your code.
Before you start, you need push access to the omnibus-gitlab repository.
If you have (someone with) access, you need to:
- Make sure that your custom branch is synced to
dev.gitlab.orgproject mirror. For example, if you are working on
gitlab-shell, make sure that your custom branch is pushed to the
- Create a branch in the omnibus-gitlab repository
- In this branch, open the related version file of the component and specify
the name of your branch. For example, if you are working on
- Commit and push the omnibus-gitlab branch to
This will trigger a build of the custom package, and if the build is successful, you will see a link at the bottom of the build trace with which you will be able to download the custom package.
You can also change the verbosity of the build output using the CI build infrastructure.
In CI/CD variables on the omnibus-gitlab project settings (on dev.gitlab.org), add
BUILD_LOG_LEVEL variable with
debug and run the pipeline.