added logos and pipeline

PavelLinearB · PavelLinearB · commit 9beb554a3fca · 2024-12-08T20:04:25.000+02:00
diff --git a/docs/automation-actions.md b/docs/automation-actions.md
@@ -12,27 +12,28 @@ Actions are the end results of the automation described in your `.cm` file.
 
     - :fontawesome-brands-github: Supported on GitHub
     - :fontawesome-brands-gitlab: Supported on GitLab
+    - :fontawesome-brands-bitbucket: Supported on Bitbucket
     - :fontawesome-solid-flask: Open beta - Feature is under development and currently available for all
 
 ## Overview
 
 [`send-http-request`](#send-http-request) is executed immediately after the evaluation of the condition.
 For all other actions, gitStream executes the actions in the order they are listed per automation. If an action result fails, the following actions will not be executed.
 
-- [`add-comment`](#add-comment) :fontawesome-brands-github: :fontawesome-brands-gitlab:
+- [`add-comment`](#add-comment) :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
 - [`add-github-check`](#add-github-check) :fontawesome-brands-github:
 - [`add-label`](#add-label) :fontawesome-brands-github: :fontawesome-brands-gitlab:
 - [`add-labels`](#add-labels) :fontawesome-brands-github: :fontawesome-brands-gitlab:
-- [`add-reviewers`](#add-reviewers) :fontawesome-brands-github: :fontawesome-brands-gitlab:
+- [`add-reviewers`](#add-reviewers) :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
 - [`add-thread`](#add-thread) :fontawesome-brands-gitlab:
-- [`approve`](#approve) :fontawesome-brands-github: :fontawesome-brands-gitlab:
-- [`close`](#close) :fontawesome-brands-github: :fontawesome-brands-gitlab:
-- [`explain-code-experts`](#explain-code-experts) :fontawesome-brands-github: :fontawesome-brands-gitlab:
-- [`merge`](#merge) :fontawesome-brands-github: :fontawesome-brands-gitlab:
-- [`request-changes`](#request-changes) :fontawesome-brands-github: :fontawesome-brands-gitlab:
+- [`approve`](#approve) :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
+- [`close`](#close) :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
+- [`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:
 - [`run-github-workflow`](#run-github-workflow) :fontawesome-brands-github:
-- [`send-http-request`](#send-http-request) :fontawesome-brands-github:
+- [`send-http-request`](#send-http-request) :fontawesome-brands-github: :fontawesome-brands-bitbucket:
 - [`send-slack-message`](#send-slack-message) :fontawesome-brands-github:
 - [`set-required-approvals`](#set-required-approvals) :fontawesome-brands-github:
 - [`update-description`](#update-description) :fontawesome-brands-github:
@@ -60,7 +61,7 @@ automations:
 
 ## Reference
 
-#### `add-comment` :fontawesome-brands-github: :fontawesome-brands-gitlab:
+#### `add-comment` :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
 
 This action, once triggered, adds a comment to the PR.
 
@@ -156,7 +157,7 @@ This is a managed action, when a PR updates existing labels that were added by g
 </div>
 
 
-#### `add-reviewers` :fontawesome-brands-github: :fontawesome-brands-gitlab:
+#### `add-reviewers` :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
 
 This action, once triggered, sets a specific reviewer.
 
@@ -236,7 +237,7 @@ automations:
           gt: 10
 ```
 
-#### `approve` :fontawesome-brands-github: :fontawesome-brands-gitlab:
+#### `approve` :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
 
 This action, once triggered, approves the PR for merge.
 
@@ -251,7 +252,7 @@ automations:
       - action: approve@v1
 ```
 
-#### `close` :fontawesome-brands-github: :fontawesome-brands-gitlab:
+#### `close` :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
 
 This action, once triggered, close the PR without merging.
 
@@ -269,7 +270,7 @@ automations:
       - action: close@v1
 ```
 
-#### `merge` :fontawesome-brands-github: :fontawesome-brands-gitlab:
+#### `merge` :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
 
 Once triggered, merge the PR if possible. It can be set to wait for all checks to pass or only required ones.
 
@@ -294,7 +295,7 @@ automations:
           rebase_on_merge: true
 ```
 
-#### `request-changes` :fontawesome-brands-github: :fontawesome-brands-gitlab:
+#### `request-changes` :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
 
 This action, once triggered, requests changes on the PR. As long as request change is set, gitStream will block the PR merge.
 
@@ -400,7 +401,7 @@ has:
   	* This action will invoke the run of a workflow dispatch; thus, it might result in significant GitHub action minutes charge.
   	* We encourage you to use this action with [custom triggers](./execution-model.md#explicit-triggers)
 
-#### `send-http-request` :fontawesome-brands-github:
+#### `send-http-request` :fontawesome-brands-github: :fontawesome-brands-bitbucket:
 
 The action, once triggered, sends an HTTP request to the specified URL
 <div class="filter-details" markdown=1>
diff --git a/docs/bitbucket-installation.md b/docs/bitbucket-installation.md
@@ -35,7 +35,7 @@ Create a `gitstream.cm` rules file in the root directory of your repository's de
 
 !!! example "Example Configuration"
     ```yaml
-    --8<-- "docs/downloads/gitstream.cm"
+    --8<-- "docs/downloads/gitstream-bb.cm"
     ```
 
 ## Create a Bitbucket Pipeline
diff --git a/docs/downloads/bitbucket-pipelines.yml b/docs/downloads/bitbucket-pipelines.yml
@@ -0,0 +1,50 @@
+# Code generated by gitStream - DO NOT EDIT
+
+image: atlassian/default-image:4
+
+pipelines:
+  # Pipelines that can only be triggered manually
+  custom:
+    gitstream:
+      - variables:
+          - name: client_payload
+            description: the client payload
+          - name: head_ref
+            description: the head sha
+          - name: base_ref
+            description: The base sha
+          - name: resolver_url
+            description: the resolver url to pass results to
+          - name: resolver_token
+            description: Optional resolver token for resolver service
+          - name: debug_mode
+            description: Debug mode
+            default: 'true'
+          - name: oauth_token
+            description: token to do operations in bitbucket
+          - name: full_repo
+            description: workspace/repo
+      - step:
+          name: /:\ gitstream workflow automation
+          max-time: 5
+          clone:
+            enabled: false
+          services:
+            - docker
+          script:
+            - git clone https://x-token-auth:$oauth_token@bitbucket.org/$full_repo.git gitstream/repo
+            - git clone https://x-token-auth:$oauth_token@bitbucket.org/$BITBUCKET_WORKSPACE/$BITBUCKET_REPO_SLUG.git gitstream/cm
+            - cd gitstream/repo
+            - git fetch --all
+            - git checkout $base_ref
+            - git checkout $head_ref
+            - docker pull gitstream/rules-engine:latest
+            - |
+              docker run -v $BITBUCKET_CLONE_DIR/gitstream:/code \
+              -e SLACK_PRIVATE_MISHA_CHANNEL_WEBHOOK=$SLACK_PRIVATE_MISHA_CHANNEL_WEBHOOK \
+              -e HEAD_REF=$head_ref \
+              -e BASE_REF=$base_ref \
+              -e CLIENT_PAYLOAD="$client_payload" \
+              -e RULES_RESOLVER_URL=$resolver_url \
+              -e RULES_RESOLVER_TOKEN=$resolver_token \
+              -e DEBUG_MODE=$debug_mode gitstream/rules-engine:latest
diff --git a/docs/downloads/gitstream-bb.cm b/docs/downloads/gitstream-bb.cm
@@ -0,0 +1,54 @@
+# -*- mode: yaml -*-
+# This example configuration provides basic automations to get started with gitStream.
+# View the gitStream quickstart for more examples: https://docs.gitstream.cm/examples/
+manifest:
+  version: 1.0
+
+
+automations:
+  # Add a comment that indicates how many minutes it will take to review the PR.
+  estimated_time_to_review:
+    if:
+      - true
+    run:
+      - action: add-comment@v1
+        args:
+          comment: "{{ calc.etr }} min review"
+
+  # Inform PR authors when they fail to reference Jira tickets in the PR title or description.
+  comment_missing_jira_info:
+    if:
+      - {{ not (has.jira_ticket_in_title or has.jira_ticket_in_desc) }}
+    run:
+      - action: add-comment@v1
+        args:
+          comment: |
+            This PR is missing a Jira ticket reference in the title or description.
+            Please add a Jira ticket reference to the title or description of this PR.
+
+  # Post a comment that lists the best experts for the files that were modified.
+  explain_code_experts:
+    if:
+      - true
+    run:
+      - action: explain-code-experts@v1 
+        args:
+          gt: 10 
+
+
+# +----------------------------------------------------------------------------+
+# | Custom Expressions                                                         |
+# | https://docs.gitstream.cm/how-it-works/#custom-expressions                 |
+# +----------------------------------------------------------------------------+
+
+calc:
+  etr: {{ branch | estimatedReviewTime }}
+
+has:
+  jira_ticket_in_title: {{ pr.title | includes(regex=r/\b[A-Za-z]+-\d+\b/) }}
+  jira_ticket_in_desc: {{ pr.description | includes(regex=r/atlassian.net\/browse\/\w{1,}-\d{3,4}/) }}
+
+colors:
+  red: 'b60205'
+  yellow: 'fbca04'
+  green: '0e8a16'
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -11,6 +11,7 @@ nav:
   - Guide:
     - GitHub Setup: github-installation.md
     - GitLab Setup: gitlab-installation.md
+    - Bitbucket Setup: bitbucket-installation.md
     - Custom GitHub App: custom-github-app.md
     - How gitStream works: how-it-works.md
     - Your First Automation: quick-start.md
