BigW Consortium Gitlab

enable_or_disable_ci.md 2.29 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
## Enable or disable GitLab CI

_To effectively use GitLab CI, you need a valid [`.gitlab-ci.yml`](yaml/README.md)
file present at the root directory of your project and a
[runner](runners/README.md) properly set up. You can read our
[quick start guide](quick_start/README.md) to get you started._

If you are using an external CI server like Jenkins or Drone CI, it is advised
to disable GitLab CI in order to not have any conflicts with the commits status
API.

---

As of GitLab 8.2, GitLab CI is mainly exposed via the `/builds` page of a
project. Disabling GitLab CI in a project does not delete any previous builds.
In fact, the `/builds` page can still be accessed, although it's hidden from
the left sidebar menu.

GitLab CI is enabled by default on new installations and can be disabled either
20
individually under each project's settings, or site-wide by modifying the
21 22 23
settings in `gitlab.yml` and `gitlab.rb` for source and Omnibus installations
respectively.

24
### Per-project user setting
25 26 27 28 29 30 31 32 33 34

The setting to enable or disable GitLab CI can be found with the name **Builds**
under the **Features** area of a project's settings along with **Issues**,
**Merge Requests**, **Wiki** and **Snippets**. Select or deselect the checkbox
and hit **Save** for the settings to take effect.

![Features settings](img/features_settings.png)

---

35
### Site-wide administrator setting
36

37
You can disable GitLab CI site-wide, by modifying the settings in `gitlab.yml`
38 39
and `gitlab.rb` for source and Omnibus installations respectively.

40
Two things to note:
41

42 43
1. Disabling GitLab CI, will affect only newly-created projects. Projects that
   had it enabled prior to this modification, will work as before.
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
1. Even if you disable GitLab CI, users will still be able to enable it in the
   project's settings.

---

For installations from source, open `gitlab.yml` with your editor and set
`builds` to `false`:

```yaml
## Default project features settings
default_projects_features:
  issues: true
  merge_requests: true
  wiki: true
  snippets: false
  builds: false
```

Save the file and restart GitLab: `sudo service gitlab restart`.

For Omnibus installations, edit `/etc/gitlab/gitlab.rb` and add the line:

```
67
gitlab_rails['gitlab_default_projects_features_builds'] = false
68 69 70
```

Save the file and reconfigure GitLab: `sudo gitlab-ctl reconfigure`.