Skip to content

Commit f1a17ef

Browse files
committed
gitlab installation fixes
1 parent e1dfbaa commit f1a17ef

File tree

2 files changed

+18
-19
lines changed

2 files changed

+18
-19
lines changed

docs/automation-actions.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,11 @@ For all other actions, gitStream executes the actions in the order they are list
3333
- [`request-changes`](#request-changes) :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
3434
- [`require-reviewers`](#require-reviewers) :fontawesome-brands-github:
3535
- [`run-github-workflow`](#run-github-workflow) :fontawesome-brands-github:
36-
- [`send-http-request`](#send-http-request) :fontawesome-brands-github: :fontawesome-brands-bitbucket:
37-
- [`send-slack-message`](#send-slack-message) :fontawesome-brands-github:
36+
- [`send-http-request`](#send-http-request) :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
37+
- [`send-slack-message`](#send-slack-message) :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
3838
- [`set-required-approvals`](#set-required-approvals) :fontawesome-brands-github:
39-
- [`update-description`](#update-description) :fontawesome-brands-github:
40-
- [`update-title`](#update-title) :fontawesome-brands-github:
39+
- [`update-description`](#update-description) :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
40+
- [`update-title`](#update-title) :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
4141

4242
!!! note
4343

@@ -212,7 +212,7 @@ automations:
212212
comment: "Please make sure this change request is documented before merging"
213213
```
214214

215-
#### `explain-code-experts` :fontawesome-brands-github: :fontawesome-brands-gitlab:
215+
#### `explain-code-experts` :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
216216

217217
This action, shall add a comment with codeExperts suggestion. If the comment already exists, the comment shall be edited.
218218

@@ -401,7 +401,7 @@ has:
401401
* This action will invoke the run of a workflow dispatch; thus, it might result in significant GitHub action minutes charge.
402402
* We encourage you to use this action with [custom triggers](./execution-model.md#explicit-triggers)
403403

404-
#### `send-http-request` :fontawesome-brands-github: :fontawesome-brands-bitbucket:
404+
#### `send-http-request` :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
405405

406406
The action, once triggered, sends an HTTP request to the specified URL
407407
<div class="filter-details" markdown=1>
@@ -431,7 +431,7 @@ automations:
431431
body: '{"text": "Hello, world!"}'
432432
```
433433

434-
#### `send-slack-message` :fontawesome-brands-github:
434+
#### `send-slack-message` :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
435435

436436
The action, once triggered, sends a webhook with a message content to a Slack app.
437437
To use this action, [create a Slack app](https://api.slack.com/messaging/webhooks#getting_started) with Incoming Webhooks enabled. gitStream uses the webhook URL to send the message.
@@ -485,7 +485,7 @@ automations:
485485

486486
To allow this action to block merge, you should enable branch protection, and gitStream has to be set as required check in GitHub.
487487

488-
#### `update-description` :fontawesome-brands-github:
488+
#### `update-description` :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
489489
This action, when triggered, updates the PR description with new content.
490490

491491
This is a managed action. When a PR updates, the existing comments that were added by gitStream are re-evaluated, and those that are not applicable are removed.
@@ -520,7 +520,7 @@ jira_ticket_from_title: {{ pr.title | capture(regex=r/\b[A-Za-z]+-\d+\b/) }}
520520
```
521521

522522

523-
#### `update-title` :fontawesome-brands-github:
523+
#### `update-title` :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
524524
This action, when triggered, updates the PR title with new content.
525525

526526
This is a managed action. When a PR updates, the existing comments that were added by gitStream are re-evaluated, and those that are not applicable are removed.

docs/gitlab-installation.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Once your gitStream configuration file is set up, you need a GitLab CI configura
5858

5959
First, [register the runner](https://docs.gitlab.com/runner/register/){:target="_blank"} with a tag, and use the named tag in the `.gitlab-ci.yml` file
6060

61-
### Shell executors
61+
**Shell executors**
6262

6363
Use the tag created above in the workflow file `cm/.gitlab-ci.yml` instead `REGISTERED-TAG`
6464
``` yaml+jinja
@@ -70,8 +70,9 @@ Once your gitStream configuration file is set up, you need a GitLab CI configura
7070

7171
First, [register the runner](https://docs.gitlab.com/runner/register/){:target="_blank"} with a tag, and use the named tag in the `.gitlab-ci.yml` file
7272

73-
### Kubernetes executors
74-
1. Ensure your runner configuration (`config.toml` for example) has the followig:
73+
**Kubernetes executors**
74+
75+
1. Ensure your runner configuration (`config.toml` for example) has the followig:
7576
``` yaml
7677
[runners.kubernetes]
7778
privileged = true
@@ -89,18 +90,16 @@ Once your gitStream configuration file is set up, you need a GitLab CI configura
8990
- docker pull YOUR-REGISTRY-URL/gitstream/rules-engine:latest
9091
```
9192
The docker image can be pulled to your private repository from [DockerHub](https://hub.docker.com/r/gitstream/rules-engine){:target=_blank}.
92-
## Next Step
93-
If you successfully complete these instructions, gitStream will now do these two things.
9493

95-
When a PR is created or changed, apply or update a label that provides an estimated time to review.
96-
![Estimated Review Time label](automations/provide-estimated-time-to-review/provide_estimated_time_to_review.png)
94+
## Install the gitStream Service
9795

98-
When a `suggest-reviewers` label is applied to a PR, gitStream will comment with a list of code experts.
99-
![Suggested reviewers](automations/standard/review-assignment/assign-code-experts/assign_code_experts.png)
96+
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.
10097

98+
## Next Step
99+
If you successfully complete these instructions, gitStream will now automate your code review workflows in Bitbucket.
101100

102101
!!! tip "How gitStream Works"
103-
Read our guide, [How gitStream Works](/how-it-works/), for a deeper understanding of gitStream's capabilities and how to leverage them fully and to get an overview of the gitStream syntax and automation lifecycle.
102+
Read our guide, [How gitStream Works](/how-it-works/), for a deeper understanding of gitStream's capabilities and how to leverage them fully.
104103

105104
## Additional Resources
106105

0 commit comments

Comments
 (0)