Skip to content

update docs with bitbucket triggers warning #719

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 20, 2025
Merged

update docs with bitbucket triggers warning #719

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d60e4ba
update docs
vim-zz May 20, 2025
6ec3579
Update bitbucket-installation.md
vim-zz May 20, 2025
9b54632
Update gitlab-installation.md
vim-zz May 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions docs/bitbucket-installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@ description: Install gitStream to your Bitbucket workspace.
# How to Setup gitStream with Bitbucket Cloud

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

To start automating your Bitbucket pull requests and enhancing your development workflow, please [contact our product team](mailto:product@linearb.io) to request access and receive setup instructions.
We’d love to hear your feedback and collaborate to improve this integration during the beta phase. Thank you for your interest!

!!! info "Prerequisites"

1. Bitbucket Cloud account
2. Bitbucket Pipelines enabled
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.
4. A dedicated user for gitStream, whose name includes the term **"gitstream"**.
4. A dedicated user for gitStream, whose name includes the term **"gitstream"**.
5. Allowed network connection between the runners and the following IPs:
- 13.56.203.235
- 54.151.81.98
Expand All @@ -40,7 +40,7 @@ Create a `cm` repository in your Bitbucket workspace. This repository must resid
!!! info "Configuration File Locations"
Group-level rules require your `.cm` files to be placed in the `cm` repository's root directory.
You can also define specific repo-level rules under the `.cm` folder in each of the connected repositories

!!! example "Example Configuration"
```yaml
--8<-- "docs/downloads/gitstream-bb.cm"
Expand All @@ -54,9 +54,12 @@ Once your gitStream configuration file is set up, you need a Bitbucket Pipelines
--8<-- "docs/downloads/bitbucket-pipelines.yml"
```

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

!!! warning "Explicit triggers are not supported"
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.

## Install the gitStream Service

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.
Expand All @@ -81,6 +84,6 @@ The required permissions are:
| `pullrequest: read, write` | Read and modify pull requests. |
| `webhook: read, write` | Read and manage webhooks. |
| `pipeline: read, write` | Read and write pipelines. |
| `runner: read, write` | Read and manage runners.
| `runner: read, write` | Read and manage runners.

</markdown>
3 changes: 3 additions & 0 deletions docs/gitlab-installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ Create a `cm` project (repository) in your GitLab group. This repository must be
!!! example "Example Configuration"
--8<-- "docs/downloads/gitStream-gl.cm"

!!! warning "Explicit triggers are not supported"
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.

## Create a GitLab Pipeline

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:
Expand Down