Skip to content

Commit 35bd04f

Browse files
authored
Merge pull request #627 from linear-b/LINBEE-13204-add-cm-repo-to-doc
Update bitbucket-installation.md
2 parents 343ebe0 + 209aeaa commit 35bd04f

File tree

2 files changed

+15
-16
lines changed

2 files changed

+15
-16
lines changed

docs/bitbucket-installation.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,34 +18,35 @@ description: Install gitStream to your Bitbucket workspace.
1818
Bitbucket Installation Overview
1919

2020
1. Designate a gitStream user account.
21-
2. Create a CM configuration file.
21+
2. Create a `cm` repo and `.cm` configuration file.
2222
3. Create a Bitbucket pipeline.
2323
4. Install the gitStream service.
2424

2525
## Designate a gitStream User Account
2626

2727
gitStream automation rules are executed on behalf of the user account configured when you install the gitStream service. This account must have the necessary permissions to the relevant repositories.
2828

29-
We recommend creating a dedicated service account to control access to individual repositories easily. You can also use your professional or personal Bitbucket account for this, which would result in all automations being executed under that account.
29+
We recommend creating a dedicated service account to easily control access to individual repositories. You can also use your professional or personal Bitbucket account for this, resulting in all automations being executed under that account.
3030

3131
!!! tip "Use this account when you integrate gitStream"
3232
Make sure to use this account when authorizing Bitbucket in LinearB.
3333

34-
## Create a CM Configuration File
34+
## Create a `cm` repo and `.cm` configuration file.
3535

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 must end with the `.cm` extension.
4037

38+
!!! info "Configuration File 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+
4142
!!! example "Example Configuration"
4243
```yaml
4344
--8<-- "docs/downloads/gitstream-bb.cm"
4445
```
4546

4647
## Create a Bitbucket Pipeline
4748

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:
4950

5051
```yaml
5152
--8<-- "docs/downloads/bitbucket-pipelines.yml"

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 File 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)