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/bitbucket-installation.md
+8-7Lines changed: 8 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ description: Install gitStream to your Bitbucket workspace.
18
18
Bitbucket Installation Overview
19
19
20
20
1. Designate a gitStream user account.
21
-
2. Create a CM configuration file.
21
+
2. Create a `cm` repo and `.cm` configuration file.
22
22
3. Create a Bitbucket pipeline.
23
23
4. Install the gitStream service.
24
24
@@ -31,21 +31,22 @@ We recommend creating a dedicated service account to control access to individua
31
31
!!! tip "Use this account when you integrate gitStream"
32
32
Make sure to use this account when authorizing Bitbucket in LinearB.
33
33
34
-
## Create a CM Configuration File
34
+
## Create a `cm` repo and `.cm` configuration file.
35
35
36
-
Create a `gitstream.cm` rules file in the root directory of your repository's default branch (usually `master` or `main`). This file will contain a YAML configuration that determines the workflows that run on your repositories. You can name the CM file anything you want as long as it ends in `.cm`.
37
-
38
-
!!! info "Configuration files go in the repo's root directory."
39
-
Your `.cm` files should be placed in the repository's root directory.
36
+
Create a `cm` repository in your Bitbucket workspace. This repository must reside in the same project as your 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 can have any name, but it must end with `.cm`.
40
37
38
+
!!! info "Configuration files locations"
39
+
Group-level rules require your `.cm` files to be placed in the `cm` repository's root directory.
40
+
You can also define specific repo-level rules under the `.cm` folder in each of the connected repositories
41
+
41
42
!!! example "Example Configuration"
42
43
```yaml
43
44
--8<-- "docs/downloads/gitstream-bb.cm"
44
45
```
45
46
46
47
## Create a Bitbucket Pipeline
47
48
48
-
Once your gitStream configuration file is set up, you need a Bitbucket Pipelines configuration file to trigger gitStream automations. Create a `bitbucket-pipelines.yml` file in your repository's default branch (usually `master` or `main`) and add the following configuration:
49
+
Once your gitStream configuration file is set up, you need a Bitbucket Pipelines configuration file to trigger gitStream automations. Create a `bitbucket-pipelines.yml` file in your `cm`repository's default branch and add the following configuration:
0 commit comments