You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/gitlab-installation.md
+12-30Lines changed: 12 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,43 +26,25 @@ We recommend creating a [dedicated service account](https://docs.gitlab.com/ee/u
26
26
!!! tip "Use this account when you integrate gitStream"
27
27
Make sure to use this account when authorizing GitLab in LinearB.
28
28
29
-
## 2. Create a CM Configuration File
29
+
## 2. Create a `cm` repo and a CM Configuration File
30
30
31
+
Group rules are ideal when you want to enforce consistent rules across every repo in your GitLab group. You can define them by creating a special repository named `cm` in the parent group for the git repositories on which you want to run gitStream. Here, you can add automation files that apply to **all** repositories within that group that are connected to gitStream.
31
32
32
-
You can set up gitStream for a single repo or your entire GitLab organization. Select the tab below for the instructions you want.
33
-
=== "Single Repo"
34
-
**Single Repo Setup**
33
+
Create a `cm` project (repository) in your GitLab group, and create a `gitstream.cm` rules file in the root directory of your `cm` repository's default branch (usually `master` or `main`). This file will contain a YAML configuration that determines the workflows that run on your organization's repos. You can name the CM file anything you want as long as it ends in `.cm`
35
34
36
-
Create a `.cm/gitstream.cm` rules file in your repository's default branch (usually `master` or `main`). This file will contain a YAML configuration that determines the workflows that run on the repo, and you can name it anything you want as long as it ends in `.cm`
35
+
!!! info "Configuration files go in the repo's root directory."
36
+
Group-level rules require your `.cm` files to be placed in the repository's root directory.
37
+
You can also define specific repo-level rules under the `.cm` folder in each of the connected repositories
37
38
38
-
!!! example "Example Configuration"
39
-
40
-
41
-
Here is an example of a gitStream configuration file you can use to setup some basic workflow automations.
42
-
43
-
```yaml+jinja
44
-
--8<-- "docs/downloads/gitstream.cm"
45
-
```
46
-
47
-
=== "GitLab Group"
48
-
**GitLab Group Setup**
49
-
50
-
Group rules are ideal when you want to enforce consistent rules across every repo in your GitLab group. You can define them by creating a special repository named `cm` in the parent group for the git repositories you want to run gitStream on. Here, you can add automation files that will apply to **all** repositories within that group.
51
-
52
-
Create a `cm` project (repository) in your GitLab group, and create a `gitstream.cm` rules file in the root directory of your `cm` repository's default branch (usually `master` or `main`). This file will contain a YAML configuration that determines the workflows that run on your organization's repos. You can name the CM file anything you want as long as it ends in `.cm`
53
-
54
-
!!! info "Configuration files go in the repo's root directory."
55
-
Unlike the set up instructions for a single repo, your `.cm` files should be placed in the repository's root directory.
56
-
57
-
!!! example "Example Configuration"
58
-
Here is an example of a gitStream configuration file you can use to setup some basic workflow automations.
59
-
```yaml+jinja
60
-
--8<-- "docs/downloads/gitstream.cm"
61
-
```
39
+
!!! example "Example Configuration"
40
+
Here is an example of a gitStream configuration file to set up some basic workflow automations.
41
+
```yaml+jinja
42
+
--8<-- "docs/downloads/gitstream.cm"
43
+
```
62
44
63
45
## 3. Create a GitLab Pipeline
64
46
65
-
Once your gitStream configuration file is set up, you need a GitLab CI configuration file to trigger gitStream automations. If you haven't already, create a `cm` project (repository) in your GitLab group. It should be created in the same group or a parent group of the target repositories. Create a `.gitlab-ci.yml` file in your new `cm` repository's default branch (usually `master` or `main`) and add the following configuration:
47
+
Once your gitStream configuration file is set up, you need a GitLab CI configuration file to trigger gitStream automations. Create a `cm` project (repository) in your GitLab group if you haven't already. It should be created in the same group or a parent group of the target repositories. Create a `.gitlab-ci.yml` file in your new `cm` repository's default branch (usually `master` or `main`) and add the following configuration:
0 commit comments