Skip to content

Commit bbb411b

Browse files
PavelLinearBPavelLinearB
committedSep 1, 2024·
added plugin files
1 parent 2201cf3 commit bbb411b

File tree

5 files changed

+180
-0
lines changed

5 files changed

+180
-0
lines changed
 

‎plugins/filters/suggestIssues/LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 LinearB
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎plugins/filters/suggestIssues/README.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
2+
--8<-- "plugins/filters/askAI/reference.md"
3+
4+
5+
??? note "Plugin Code: askAI"
6+
```javascript
7+
--8<-- "plugins/filters/askAI/index.js"
8+
```
9+
<div class="result" markdown>
10+
<span>
11+
</span>
12+
</div>
13+
14+
15+
??? example "gitStream CM Example: askAI"
16+
```yaml+jinja
17+
--8<-- "plugins/filters/askAI/askAI.cm"
18+
```
19+
<div class="result" markdown>
20+
<span>
21+
</span>
22+
</div>
23+
24+
[Download Source Code](https://github.com/linear-b/gitstream/tree/main/plugins/filters/askAI)

‎plugins/filters/suggestIssues/index.js

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
/**
2+
* @module suggestIssues
3+
* @description Fetches ticket recommendations based on given pull request details.
4+
* @param {object} pr - The pull request object containing title, author, and created_at properties.
5+
* @param {string} apiKey - The API key used to authenticate requests.
6+
* @returns {Array} Returns an array of suggested issues related to the current Pull Request.
7+
* @example {{ pr | suggestIssues(env.LINEARB_TOKEN) }}
8+
* @license MIT
9+
**/
10+
11+
const suggestIssues = async (pr, branch, apiKey, callback) => {
12+
const url =
13+
"https://public-api.linearb.io/api/v1/inference/get_ticket_recommendation";
14+
15+
const requestData = {
16+
request_id: `${Date.now()}-${Math.random().toString(36).substr(2, 9)}`, // <-- local UUID per call
17+
pull_request: {
18+
title: pr.title, // PR title
19+
issuer_name: pr.author, // PR author
20+
created_at: pr.created_at, // PR creation date
21+
branch_name: branch.name, // PR branch name
22+
},
23+
};
24+
25+
const result = await fetch(url, {
26+
method: "POST",
27+
headers: {
28+
"x-api-key": apiKey,
29+
"Content-Type": "application/json",
30+
"accept": "application/json",
31+
},
32+
body: JSON.stringify(requestData),
33+
})
34+
.then((response) => response.json())
35+
.then((data) => data)
36+
.catch((error) => console.log("Error:", error));
37+
38+
if (result && result.recommendations && result.recommendations.jira_tickets) {
39+
// Extract the first 3 issues
40+
const issues = result.recommendations.jira_tickets.slice(0, 3);
41+
42+
// Map to the desired object format containing the issue URL and issue title
43+
const issuesMarkdown = issues
44+
.map((issue) => ({
45+
url: issue.url,
46+
title: issue.title.replace(/\n/g, "").trim(),
47+
key: issue.issue_provider_key,
48+
score: issue.similarity_score,
49+
}))
50+
// Map to the desired object format containing the issue URL and issue title
51+
.map((issue) => `- [ ] [${issue.key}](${issue.url}) ${issue.title} _(score: ${issue.score.toFixed(2)})_ `)
52+
.join("\\n");
53+
console.log("suggestedIssues:", {issuesMarkdown});
54+
55+
return callback(null, issuesMarkdown);
56+
} else if (result && result.recommendations && Array.isArray(result.recommendations.jira_tickets) && result.recommendations.jira_tickets.length === 0) {
57+
console.log("No issues found.", JSON.stringify(result, null, 2));
58+
return callback(null, "No related issues found. The pull request title and the author were used to search the Jira board, but no good match was found.");
59+
} else {
60+
console.log("Invalid response structure:", JSON.stringify(result, null, 2) );
61+
return callback(null, "Error: Service returned an invalid response structure.");
62+
}
63+
};
64+
65+
module.exports = {
66+
async: true,
67+
filter: suggestIssues
68+
}

‎plugins/filters/suggestIssues/reference.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<a name="module_generateDescription"></a>
2+
3+
## suggestIssues
4+
A gitStream plugin to suggest issues to link to the PR
5+
6+
![Example PR description](screenshots/suggestIssues.png)
7+
8+
**Returns**: <code>\[String\]</code> - Returns a list of suggested issues
9+
**License**: MIT
10+
11+
| Param | Type | Description |
12+
| ------ | -------- | ------------------------------------------------ |
13+
| pr | `Object` | The pull request object from gitStream's context |
14+
| apiKey | `string` | The API key used to authenticate requests. |
15+
16+
17+
**Example**
18+
19+
```yaml
20+
{{ pr | suggestIssues(env.LINEARB_TOKEN) }}
21+
```

‎plugins/filters/suggestIssues/suggestIssues.cm

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# -*- mode: yaml -*-
2+
3+
manifest:
4+
version: 1.0
5+
6+
automations:
7+
# Add comment that suggests tickets for this PR when there is no linked
8+
# ticket in the title or description
9+
suggest_issues:
10+
on:
11+
- label_added
12+
if:
13+
- {{ pr.labels | match(term='suggest-ticket') | some }}
14+
run:
15+
- action: add-comment@v1
16+
args:
17+
comment: |
18+
Select one of the suggested issues to link to this PR. Once you make a selection, gitStream will automatically update the PR title and description with the selected issue key (taking into account issues opened up to the last 2 hours).
19+
20+
{{ pr | suggestedIssues(branch, env.TICKET_SUGGESTION_TOKEN) }}
21+
22+
*✨ This list was created using LinearB’s AI service*
23+
24+
# If the PR author has indicated that they used a specific issue,
25+
# add it to the PR description and title
26+
add_selected_issue_to_pr:
27+
if:
28+
- {{ pr.comments | filter(attr='commenter', term='gitstream-cm') | filter (attr='content', regex=r/\- \[x\]/) | some }}
29+
- {{ not (has.jira_ticket_in_title or has.jira_ticket_in_desc) }}
30+
run:
31+
- action: update-title@v1
32+
args:
33+
concat_mode: prepend
34+
title: |
35+
{{ selected_issue_key }} -
36+
- action: update-description@v1
37+
args:
38+
concat_mode: prepend
39+
description: |
40+
Jira issue: {{ selected_issue_key }}
41+
42+
selected_issue_key: {{ pr.comments | filter(attr='commenter', term='gitstream-cm') | map(attr='content') | filter (regex=r/\- \[x\].*/) | first | capture(regex=r/\b[A-Za-z]+-\d+\b/) }}
43+
44+
has:
45+
jira_ticket_in_title: {{ pr.title | includes(regex=r/\b[A-Za-z]+-\d+\b/) }}
46+
jira_ticket_in_desc: {{ pr.description | includes(regex=r/atlassian.net\/browse\/\w{1,}-\d{3,4}/) }}

0 commit comments

Comments
 (0)