Merge branch 'main' into custom-github-app

linear-b · Jun 26, 2024 · f124d10 · f124d10
2 parents a073215 + dd63ff9
commit f124d10
Show file tree

Hide file tree

Showing 12 changed files with 50 additions and 12 deletions.
diff --git a/docs/automation-actions.md b/docs/automation-actions.md
@@ -35,6 +35,7 @@ For all other actions, gitStream executes the actions in the order they are list
 - [`send-slack-message`](#send-slack-message) :fontawesome-solid-flask: :fontawesome-brands-github:
 - [`set-required-approvals`](#set-required-approvals) :fontawesome-brands-github:
 - [`update-description`](#update-description) :fontawesome-brands-github:
+- [`update-title`](#update-title) :fontawesome-brands-github:
 
 !!! note
 
@@ -484,9 +485,46 @@ automations:
         args:
           concat_mode: prepend
           description: |
-            {{ pr.title | capture(regex=r/\b[A-Za-z]+-\d+\b/) }}
+            {{ jira_ticket_from_title }}
 
 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}/) }}
+
+jira_ticket_from_title: {{ pr.title | capture(regex=r/\b[A-Za-z]+-\d+\b/) }}
+```
+
+
+#### `update-title` :fontawesome-brands-github:
+This action, when triggered, updates the PR title with new content.
+
+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.
+
+<div class="filter-details" markdown=1>
+
+| Args       | Usage | Type      | Description                              |
+| -----------|-------|-----------|----------------------------------------- |
+| `title` | Required | String     | Sets the PR title |
+| `concat_mode` | Optional | String     | `replace` by default, the mode to concatenate the new description with the existing one. Possible values: `prepend`, `append`, `replace` |
+</div>
+
+For example, this automation updates the PR title with the ticket info if present in the PR title.
+
+```yaml+jinja title="example"
+automations:
+  add_jira_to_title:
+    if:
+      - {{ has.jira_ticket_in_desc and (not has.jira_ticket_in_title) }}
+    run:
+      - action: update-title@v1
+        args:
+          concat_mode: prepend
+          title: |
+            {{ jira_ticket_from_desc }} -
+
+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}/) }}
+
+jira_ticket_from_desc: {{ pr.description | capture(regex=r/\b[A-Za-z]+-\d+\b/) }}
 ```
diff --git a/docs/automations/approve-tests/README.md b/docs/automations/approve-tests/README.md
@@ -1,7 +1,7 @@
 ---
 title: Automation - Approve test changes
 description: Automatically approve changes that only contain updates to tests.
-category: [efficiency, testing, quickstart]
+category: [efficiency, testing]
 quickstart: true
 ---
 # Approve test changes

diff --git a/docs/automations/integrations/copilot/flag-copilot-pr/README.md b/docs/automations/integrations/copilot/flag-copilot-pr/README.md
@@ -1,7 +1,7 @@
 ---
 title: Automation - Label GitHub Copilot PRs
 description: Automatically apply labels to PRs that are assisted by GitHub Copilot
-category: [quality, genai, copilot]
+category: [quality, genai, copilot, quickstart]
 ---
 # Automatically Label GitHub Copilot PRs
 <!-- --8<-- [start:example]-->

diff --git a/docs/automations/integrations/dependabot/approve-dependabot/README.md b/docs/automations/integrations/dependabot/approve-dependabot/README.md
@@ -1,7 +1,7 @@
 ---
 title: Automation - Approve and Merge Dependabot Changes
 description: Automatically approve and merge Dependabot PRs.
-category: [efficiency, dependabot, security]
+category: [efficiency, dependabot, security, quickstart]
 quickstart: false
 ---
 # Approve and Merge Dependabot Changes

diff --git a/docs/automations/integrations/orca/review-orca-alerts/README.md b/docs/automations/integrations/orca/review-orca-alerts/README.md
@@ -1,7 +1,7 @@
 ---
 title: Automation - Review Orca Security Alerts
 description: Automatically require review from your SecOps team for Orca Security violations in pull requests.
-category: [security, orca, quickstart]
+category: [security, orca]
 quickstart: true
 ---
 # Require Security Review for Orca Alerts

diff --git a/docs/automations/integrations/renovate/approve-renovate/README.md b/docs/automations/integrations/renovate/approve-renovate/README.md
@@ -1,7 +1,7 @@
 ---
 title: Automation - Approve and Merge Renovate Changes
 description: Automatically approve and merge Renovate PRs.
-category: [efficiency, renovate, security]
+category: [efficiency, renovate, security, quickstart]
 quickstart: false
 ---
 # Approve and Merge Renovate Changes

diff --git a/docs/automations/integrations/sonar/label-sonar/README.md b/docs/automations/integrations/sonar/label-sonar/README.md
@@ -1,7 +1,7 @@
 ---
 title: Automation - Label SonarCloud Quality Reports
 description: Automatically label PRs with SonarCloud insights.
-category: [security, sonarcloud, quickstart]
+category: [security, sonarcloud]
 quickstart: true
 ---
 # Label SonarCloud Quality Reports

diff --git a/docs/automations/provide-estimated-time-to-review/README.md b/docs/automations/provide-estimated-time-to-review/README.md
@@ -1,7 +1,7 @@
 ---
 title: Automation - Provide Estimated Time to Review
 description: Automatically label PRs with an estimated time to review.
-category: [efficiency, review, quickstart]
+category: [efficiency, review]
 quickstart: true
 ---
 # Provide Estimated Time to Review

diff --git a/docs/automations/request-screenshot/README.md b/docs/automations/request-screenshot/README.md
@@ -1,7 +1,7 @@
 ---
 title: Automation - Request Screenshot
 description: Automatically ensure PRs contain screenshots to help illustrate the changes.
-category: [quality, review]
+category: [quality, review, quickstart]
 ---
 # Request Screenshot
 If the PR lacks an image file, or link to an image in the description, apply a `no-screenshot` label and post a comment to request a screenshot. If the PR author updates the description, gitStream will remove the label.

diff --git a/docs/automations/standard/label-management/label-unresolved-threads/README.md b/docs/automations/standard/label-management/label-unresolved-threads/README.md
@@ -1,7 +1,7 @@
 ---
 title: Automation - Label Unresolved Review Threads
 description: Automatically label PRs when there are unresolved code review comments.
-category: [security, quickstart]
+category: [security]
 quickstart: true
 ---
 # Label Unresolved Review Threads

diff --git a/docs/automations/standard/link-issue-tracker/README.md b/docs/automations/standard/link-issue-tracker/README.md
@@ -1,7 +1,7 @@
 ---
 title: Automation - Automatic Project Tracker Links
 description: Automatically post PR comments that link to the associated project tracking resource.
-category: [quality, quickstart]
+category: [quality]
 quickstart: true
 ---
 

diff --git a/docs/automations/welcome-newcomer/README.md b/docs/automations/welcome-newcomer/README.md
@@ -1,7 +1,7 @@
 ---
 title: Automation - Welcome Newcomer
 description: Automatically post messages to first time PR contributors to help them get started.
-category: [review, quickstart]
+category: [review]
 quickstart: true
 ---
 # Welcome Newcomer