Skip to content

Commit a539b74

Browse files
authored
Merge pull request #628 from linear-b/gitlab-cm-repo
Update gitlab-installation.md
2 parents 6200793 + 8079fe9 commit a539b74

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

docs/gitlab-installation.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ description: Install gitStream to your GitLab organization.
1313
GitLab Installation Overview
1414

1515
1. Designate a gitStream user account.
16-
1. Create a CM configuration file.
16+
1. Create a `cm` repo and `.cm` configuration file.
1717
1. Create a GitLab pipeline.
1818
1. Install the gitStream service.
1919

@@ -26,15 +26,13 @@ We recommend creating a [dedicated service account](https://docs.gitlab.com/ee/u
2626
!!! tip "Use this account when you integrate gitStream"
2727
Make sure to use this account when authorizing GitLab in LinearB.
2828

29-
## Create a `cm` repo and a CM Configuration File
29+
## Create a `cm` repo and `.cm` configuration file.
3030

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+
Create a `cm` project (repository) in your GitLab group. This repository must be created in the same group or parent group as the target repositories. In the root directory of the default branch (usually `master` or `main`), create a `gitstream.cm` rules file to define the workflow automations. The file name can vary but must end in `.cm`.
3232

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`
34-
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
33+
!!! info "Configuration files locations"
34+
Group-level rules require your `.cm` files to be placed in the `cm` repository's root directory.
35+
You can also define specific repo-level rules under the `.cm` folder in each of the connected repositories.
3836

3937
!!! example "Example Configuration"
4038
--8<-- "docs/downloads/gitstream.cm"

0 commit comments

Comments
 (0)