Skip to content

Commit

Permalink
Merge pull request #631 from linear-b/Add-require-reviewers-and-set-r…
Browse files Browse the repository at this point in the history
…equired-approvals-fro-BB

Update automation-actions.md
  • Loading branch information
PavelLinearB authored Jan 8, 2025
2 parents 6023c71 + be17b21 commit f2a1128
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions docs/automation-actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@ For all other actions, gitStream executes the actions in the order they are list
- [`explain-code-experts`](#explain-code-experts) :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
- [`merge`](#merge) :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
- [`request-changes`](#request-changes) :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
- [`require-reviewers`](#require-reviewers) :fontawesome-brands-github:
- [`require-reviewers`](#require-reviewers) :fontawesome-brands-github: :fontawesome-brands-bitbucket:
- [`run-github-workflow`](#run-github-workflow) :fontawesome-brands-github:
- [`send-http-request`](#send-http-request) :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
- [`send-slack-message`](#send-slack-message) :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
- [`set-required-approvals`](#set-required-approvals) :fontawesome-brands-github:
- [`set-required-approvals`](#set-required-approvals) :fontawesome-brands-github: :fontawesome-brands-bitbucket:
- [`update-description`](#update-description) :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
- [`update-title`](#update-title) :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:

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


#### `require-reviewers` :fontawesome-brands-github:
#### `require-reviewers` :fontawesome-brands-github: :fontawesome-brands-bitbucket:

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

Expand All @@ -356,7 +356,11 @@ automations:

!!! attention

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

:fontawesome-brands-github: Enable branch protection and set gitStream as a required check

:fontawesome-brands-bitbucket: Select "Prevent a merge with unresolved merge checks" under Branch restrictions

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

Expand Down Expand Up @@ -459,9 +463,9 @@ automations:
slack_webhook: {{ env.SLACK_WEBHOOK }}
```

#### `set-required-approvals` :fontawesome-brands-github:
#### `set-required-approvals` :fontawesome-brands-github: :fontawesome-brands-bitbucket:

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.
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.

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

Expand All @@ -482,9 +486,14 @@ automations:
approvals: 2
```


!!! attention

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

:fontawesome-brands-github: Enable branch protection and set gitStream as a required check

:fontawesome-brands-bitbucket: Select "Prevent a merge with unresolved merge checks" under Branch restrictions

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

0 comments on commit f2a1128

Please sign in to comment.