Skip to content

Commit f2a1128

Browse files
authored
Merge pull request #631 from linear-b/Add-require-reviewers-and-set-required-approvals-fro-BB
Update automation-actions.md
2 parents 6023c71 + be17b21 commit f2a1128

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

docs/automation-actions.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@ For all other actions, gitStream executes the actions in the order they are list
3131
- [`explain-code-experts`](#explain-code-experts) :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
3232
- [`merge`](#merge) :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
3333
- [`request-changes`](#request-changes) :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
34-
- [`require-reviewers`](#require-reviewers) :fontawesome-brands-github:
34+
- [`require-reviewers`](#require-reviewers) :fontawesome-brands-github: :fontawesome-brands-bitbucket:
3535
- [`run-github-workflow`](#run-github-workflow) :fontawesome-brands-github:
3636
- [`send-http-request`](#send-http-request) :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
3737
- [`send-slack-message`](#send-slack-message) :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
38-
- [`set-required-approvals`](#set-required-approvals) :fontawesome-brands-github:
38+
- [`set-required-approvals`](#set-required-approvals) :fontawesome-brands-github: :fontawesome-brands-bitbucket:
3939
- [`update-description`](#update-description) :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
4040
- [`update-title`](#update-title) :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
4141

@@ -330,7 +330,7 @@ automations:
330330
:fontawesome-brands-gitlab: Enable the "All threads must be resolved" Merge check
331331

332332

333-
#### `require-reviewers` :fontawesome-brands-github:
333+
#### `require-reviewers` :fontawesome-brands-github: :fontawesome-brands-bitbucket:
334334

335335
This action, once triggered, requires a specific reviewer approval. The PR merge is blocked till approved by either of the listed users or teams.
336336

@@ -356,7 +356,11 @@ automations:
356356

357357
!!! attention
358358

359-
To allow this action to block merge, you should enable branch protection, and gitStream has to be set as required check in GitHub.
359+
To allow this action to block merge, The following settings should be set:
360+
361+
:fontawesome-brands-github: Enable branch protection and set gitStream as a required check
362+
363+
:fontawesome-brands-bitbucket: Select "Prevent a merge with unresolved merge checks" under Branch restrictions
360364

361365
#### `run-github-workflow` :fontawesome-brands-github:
362366

@@ -459,9 +463,9 @@ automations:
459463
slack_webhook: {{ env.SLACK_WEBHOOK }}
460464
```
461465

462-
#### `set-required-approvals` :fontawesome-brands-github:
466+
#### `set-required-approvals` :fontawesome-brands-github: :fontawesome-brands-bitbucket:
463467

464-
This action, once triggered, blocks PR merge till the desired reviewers approved the PR. The actions fail the check to prevent the PR for merge.
468+
This action, once triggered, blocks PR merge till the desired reviewers approve the PR. The actions fail the check to prevent the PR from merging.
465469

466470
<div class="filter-details" markdown=1>
467471

@@ -482,9 +486,14 @@ automations:
482486
approvals: 2
483487
```
484488

489+
485490
!!! attention
486491

487-
To allow this action to block merge, you should enable branch protection, and gitStream has to be set as required check in GitHub.
492+
To allow this action to block merge, The following settings should be set:
493+
494+
:fontawesome-brands-github: Enable branch protection and set gitStream as a required check
495+
496+
:fontawesome-brands-bitbucket: Select "Prevent a merge with unresolved merge checks" under Branch restrictions
488497

489498
#### `update-description` :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
490499
This action, when triggered, updates the PR description with new content.

0 commit comments

Comments
 (0)