From 472b357a121c81889de019832728a1cb74d691d0 Mon Sep 17 00:00:00 2001 From: PavelLinearB Date: Thu, 23 Jan 2025 11:03:23 +0200 Subject: [PATCH] added icon and note --- .../LinearBAI/describe-pr/README.md | 7 ++- docs/filter-functions.md | 52 +++++++++++-------- 2 files changed, 35 insertions(+), 24 deletions(-) diff --git a/docs/automations/integrations/LinearBAI/describe-pr/README.md b/docs/automations/integrations/LinearBAI/describe-pr/README.md index 97326aa4..f6dc161e 100644 --- a/docs/automations/integrations/LinearBAI/describe-pr/README.md +++ b/docs/automations/integrations/LinearBAI/describe-pr/README.md @@ -4,11 +4,16 @@ description: Use gitStream's integration with AI services to generate a summary category: [quality, genai, copilot, tests, efficiency] starter_kits: [genai] --- -# Add PR Description Using LinearB's AI +# Add PR Description Using LinearB's AI :material-star-circle: Use the `AI_DescribePR` filter to automatically generate and append a concise, AI-generated description to a pull request. This ensures that all PRs include meaningful and helpful descriptions, improving review efficiency. +!!! note "Premium Feature" + This filter uses LinearB’s AI service and is available exclusively for paid accounts. + + If you’re interested in unlocking this feature, [contact our sales team](https://linearb.io/book-a-demo) to learn more. + ![summarized-pr](/automations/integrations/LinearBAI/describe-pr/LinearB-AI-describe-pr.png) !!! info "Configuration Description" diff --git a/docs/filter-functions.md b/docs/filter-functions.md index 13ff626a..13518c6e 100644 --- a/docs/filter-functions.md +++ b/docs/filter-functions.md @@ -8,7 +8,8 @@ Filters can change the look and format of the source data, or even generate new !!! note - Items marked with :octicons-beaker-24: are under development and are not available yet. + - Items marked with :octicons-beaker-24: are under development and are not available yet. + - Items marked with :material-star-circle: are available exclusively for paid accounts. To unlock this feature, [contact our sales team](https://linearb.io/book-a-demo). ## Overview @@ -39,27 +40,27 @@ The following functions are supported in addition to the built-in functions prov
-| Function | Input | Args | Output | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | -------------------------------------------------- | ----------------------- | -| [`AI_DescribePR`](#ai_describepr)
Returns an AI-generated description of the PR based on the provided input diff | Object | - | String | -| [`allDocs`](#alldocs)
Checks the list includes only images | [`files`](./context-variables.md#files) | - | Bool | -| [`allImages`](#allimages)
Checks the list includes only images | [`files`](./context-variables.md#files) | - | Bool | -| [`allTests`](#alltests)
Checks the list includes only tests | [`files`](./context-variables.md#files) | - | Bool | -| [`codeExperts`](#codeexperts)
Get list of contributors based on expert reviewer model results | [`repo`](./context-variables.md#repo) | `gt`, `lt` | [String] | -| [`decode`](#decode)
Decode Base64 encoded string into an object | String (Base64 encoded) | - | Object | -| [`encode`](#encode)
Encode data into Base64 encoded string | Object | - | String (Base64 encoded) | -| [`estimatedReviewTime`](#estimatedreviewtime)
Estimated review time in minutes | [`branch`](./context-variables.md#branch) | - | Integer | -| [`extensions`](#extensions)
Lists all the unique file extensions | [String] | - | [String] | -| [`extractJitFindings`](#extractjitfindings) :fontawesome-brands-github:
Get an object with a summary of the findings found by the Jit scan | [`pr`](./context-variables.md#pr) | - | Object | -| [`extractSonarFindings`](#extractsonarfindings) :fontawesome-brands-github:
Get an object with a summary of the findings found by the SonarCloud scan | [`pr`](./context-variables.md#pr) | - | Object | -| [`explainRankByGitBlame`](#explainrankbygitblame)
Short markdown text explaining rankByGitBlame results | [`repo`](./context-variables.md#repo) | `gt`, `lt` | [String] | -| [`isFirstCommit`](#isfirstcommit)
Checks if its the author first commit in the repo | [`repo.contributors`](./context-variables.md#repo) | String | Bool | -| [`isFormattingChange`](#isformattingchange)
Checks that only formatting changed | [[`FileDiff` ](./context-variables.md#filediff-structure)] | - | Bool | -| [`mapToEnum`](#maptoenum)
return the enum value matches to the input key | String | Enum object | Object | -| [`matchDiffLines`](#matchdifflines)
Match every line in diff | [[`FileDiff` ](./context-variables.md#filediff-structure)] | `regex`, `ignoreWhiteSpaces` | [Bool] | -| [`rankByGitActivity`](#rankbygitactivity)
Get list of contributors based on `git-commit` activity | [`repo`](./context-variables.md#repo) | `gt`, `lt` | [String] | -| [`rankByGitBlame`](#rankbygitblame)
Get list of contributors based on `git-blame` results | [`repo`](./context-variables.md#repo) | `gt`, `lt` | [String] | -| [`readFile`](#readfile)
Reads the contents of a file from the current branch or "cm" folder | String - The file path | String (optional) - the file type. `txt` or `json` | String | +| Function | Input | Args | Output | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------- | -------------------------------------------------- | ----------------------- | +| [`AI_DescribePR`](#ai_describepr) :material-star-circle:{ title="Premium feature" }
Returns an AI-generated description of the PR based on the provided input diff | Object | - | String | +| [`allDocs`](#alldocs)
Checks the list includes only images | [`files`](./context-variables.md#files) | - | Bool | +| [`allImages`](#allimages)
Checks the list includes only images | [`files`](./context-variables.md#files) | - | Bool | +| [`allTests`](#alltests)
Checks the list includes only tests | [`files`](./context-variables.md#files) | - | Bool | +| [`codeExperts`](#codeexperts)
Get list of contributors based on expert reviewer model results | [`repo`](./context-variables.md#repo) | `gt`, `lt` | [String] | +| [`decode`](#decode)
Decode Base64 encoded string into an object | String (Base64 encoded) | - | Object | +| [`encode`](#encode)
Encode data into Base64 encoded string | Object | - | String (Base64 encoded) | +| [`estimatedReviewTime`](#estimatedreviewtime)
Estimated review time in minutes | [`branch`](./context-variables.md#branch) | - | Integer | +| [`extensions`](#extensions)
Lists all the unique file extensions | [String] | - | [String] | +| [`extractJitFindings`](#extractjitfindings) :fontawesome-brands-github:
Get an object with a summary of the findings found by the Jit scan | [`pr`](./context-variables.md#pr) | - | Object | +| [`extractSonarFindings`](#extractsonarfindings) :fontawesome-brands-github:
Get an object with a summary of the findings found by the SonarCloud scan | [`pr`](./context-variables.md#pr) | - | Object | +| [`explainRankByGitBlame`](#explainrankbygitblame)
Short markdown text explaining rankByGitBlame results | [`repo`](./context-variables.md#repo) | `gt`, `lt` | [String] | +| [`isFirstCommit`](#isfirstcommit)
Checks if its the author first commit in the repo | [`repo.contributors`](./context-variables.md#repo) | String | Bool | +| [`isFormattingChange`](#isformattingchange)
Checks that only formatting changed | [[`FileDiff` ](./context-variables.md#filediff-structure)] | - | Bool | +| [`mapToEnum`](#maptoenum)
return the enum value matches to the input key | String | Enum object | Object | +| [`matchDiffLines`](#matchdifflines)
Match every line in diff | [[`FileDiff` ](./context-variables.md#filediff-structure)] | `regex`, `ignoreWhiteSpaces` | [Bool] | +| [`rankByGitActivity`](#rankbygitactivity)
Get list of contributors based on `git-commit` activity | [`repo`](./context-variables.md#repo) | `gt`, `lt` | [String] | +| [`rankByGitBlame`](#rankbygitblame)
Get list of contributors based on `git-blame` results | [`repo`](./context-variables.md#repo) | `gt`, `lt` | [String] | +| [`readFile`](#readfile)
Reads the contents of a file from the current branch or "cm" folder | String - The file path | String (optional) - the file type. `txt` or `json` | String |
### Named arguments @@ -315,7 +316,12 @@ Checks whether any element in the list is `true`. In case the list of elements {{ files | match(list=['src', 'dest']) | some }} ``` -#### `AI_DescribePR` +#### `AI_DescribePR` :material-star-circle: { title="Premium feature" } + +!!! note "Premium Feature" + This filter uses LinearB’s AI service and is available exclusively for paid accounts. + + If you’re interested in unlocking this feature, [contact our sales team](https://linearb.io/book-a-demo) to learn more. Leverage LinearB's AI to assist with generating a concise and meaningful description for pull requests based on the provided context. Streamline the review process by summarizing the purpose and key changes in a PR, reducing the manual effort and cognitive load for developers and reviewers.