Skip to content

Commit a214f37

Browse files
authored
Merge pull request #719 from linear-b/add-warning-for-bb-triggers
update docs with bitbucket triggers warning
2 parents 837c252 + 9b54632 commit a214f37

File tree

2 files changed

+13
-7
lines changed

2 files changed

+13
-7
lines changed

docs/bitbucket-installation.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,16 @@ description: Install gitStream to your Bitbucket workspace.
55
# How to Setup gitStream with Bitbucket Cloud
66

77
!!! info "gitStream for Bitbucket Cloud is currently in **beta**"
8-
9-
To start automating your Bitbucket pull requests and enhancing your development workflow, please [contact our product team](mailto:[email protected]) to request access and receive setup instructions.
10-
We’d love to hear your feedback and collaborate to improve this integration during the beta phase. Thank you for your interest!
8+
9+
To start automating your Bitbucket pull requests and enhancing your development workflow, please [contact our product team](mailto:[email protected]) to request access and receive setup instructions.
10+
We’d love to hear your feedback and collaborate to improve this integration during the beta phase. Thank you for your interest!
1111

1212
!!! info "Prerequisites"
1313

1414
1. Bitbucket Cloud account
1515
2. Bitbucket Pipelines enabled
1616
3. <a href="https://app.linearb.io/login" target="_blank">Login</a>, or <a href="https://app.linearb.io/sign-up" target="_blank">create a free account</a> on the LinearB app, and follow the steps to connect gitStream using a Bitbucket integration.
17-
4. A dedicated user for gitStream, whose name includes the term **"gitstream"**.
17+
4. A dedicated user for gitStream, whose name includes the term **"gitstream"**.
1818
5. Allowed network connection between the runners and the following IPs:
1919
- 13.56.203.235
2020
- 54.151.81.98
@@ -40,7 +40,7 @@ Create a `cm` repository in your Bitbucket workspace. This repository must resid
4040
!!! info "Configuration File Locations"
4141
Group-level rules require your `.cm` files to be placed in the `cm` repository's root directory.
4242
You can also define specific repo-level rules under the `.cm` folder in each of the connected repositories
43-
43+
4444
!!! example "Example Configuration"
4545
```yaml
4646
--8<-- "docs/downloads/gitstream-bb.cm"
@@ -54,9 +54,12 @@ Once your gitStream configuration file is set up, you need a Bitbucket Pipelines
5454
--8<-- "docs/downloads/bitbucket-pipelines.yml"
5555
```
5656

57-
!!! warning "Note"
57+
!!! warning "Labels are not supported"
5858
The `add-label` action is not supported in Bitbucket as Bitbucket does not have a native labeling feature.
5959

60+
!!! warning "Explicit triggers are not supported"
61+
The `triggers` and `on` functionality are not currently supported in Bitbucket. If you include them in your CM automation files, gitStream will skip the automations entirely.
62+
6063
## Install the gitStream Service
6164

6265
To complete the setup, install the gitStream service in your Bitbucket workspace. Follow the instructions provided in the LinearB app to connect your Bitbucket account and repositories to gitStream.
@@ -81,6 +84,6 @@ The required permissions are:
8184
| `pullrequest: read, write` | Read and modify pull requests. |
8285
| `webhook: read, write` | Read and manage webhooks. |
8386
| `pipeline: read, write` | Read and write pipelines. |
84-
| `runner: read, write` | Read and manage runners.
87+
| `runner: read, write` | Read and manage runners.
8588

8689
</markdown>

docs/gitlab-installation.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,9 @@ Create a `cm` project (repository) in your GitLab group. This repository must be
4040
!!! example "Example Configuration"
4141
--8<-- "docs/downloads/gitStream-gl.cm"
4242

43+
!!! warning "Explicit triggers are not supported"
44+
The `triggers` and `on` functionality are not currently supported in GitLab. If you include them in your CM automation files, gitStream will skip the automations entirely.
45+
4346
## Create a GitLab Pipeline
4447

4548
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

Comments
 (0)