From d60e4ba0089c9fa06d866fc2dabc59752925619e Mon Sep 17 00:00:00 2001 From: Ofer Affias Date: Tue, 20 May 2025 11:21:25 +0300 Subject: [PATCH 1/3] update docs --- docs/bitbucket-installation.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/docs/bitbucket-installation.md b/docs/bitbucket-installation.md index 7ff117e57..78e95c413 100644 --- a/docs/bitbucket-installation.md +++ b/docs/bitbucket-installation.md @@ -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. Login, or create a free account 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 @@ -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" @@ -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 ignore them and will use the default triggering as sepecified in [`Trigger Control`](./execution-model.md#triggers-section). + ## 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. @@ -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. From 6ec357912094ae1f52ced1e5b271de22bbd49f22 Mon Sep 17 00:00:00 2001 From: Ofer Affias Date: Tue, 20 May 2025 11:54:46 +0300 Subject: [PATCH 2/3] Update bitbucket-installation.md --- docs/bitbucket-installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/bitbucket-installation.md b/docs/bitbucket-installation.md index 78e95c413..0c70445dc 100644 --- a/docs/bitbucket-installation.md +++ b/docs/bitbucket-installation.md @@ -58,7 +58,7 @@ Once your gitStream configuration file is set up, you need a Bitbucket Pipelines 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 ignore them and will use the default triggering as sepecified in [`Trigger Control`](./execution-model.md#triggers-section). + 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 From 9b54632e738dfd28f1fc5aeca4c216aded9bcafa Mon Sep 17 00:00:00 2001 From: Ofer Affias Date: Tue, 20 May 2025 11:56:00 +0300 Subject: [PATCH 3/3] Update gitlab-installation.md --- docs/gitlab-installation.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/gitlab-installation.md b/docs/gitlab-installation.md index f6333daf2..841c024a7 100644 --- a/docs/gitlab-installation.md +++ b/docs/gitlab-installation.md @@ -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: