upload annotations in github pull requests #501

pelikhan · 2024-06-01T13:39:14Z

Add CLI option to upload annotations as pull request comments.

🆕 Added a new CLI option -prr, --pull-request-reviews to create pull request reviews from annotations in docs/src/content/docs/reference/cli/commands.md and packages/cli/src/cli.ts.
🏁 Made the run command the default command in the CLI by adding { isDefault: true } in packages/cli/src/cli.ts.
📝 Modified the runScript function in packages/cli/src/run.ts to support the new pullRequestReviews option.
🚀 Implemented the githubCreatePullRequestReviews function in packages/core/src/github.ts to create pull request reviews based on annotations.
🧹 Cleaned up and refactored the parseAnnotations function in packages/core/src/annotations.ts to prevent duplicate annotations by using a Record instead of an array.
🛠️ Updated githubUpsetPullRequest and githubCreateIssueComment functions in packages/core/src/github.ts to include the new script parameter and append a generated comment with a link to the run URL.
🛂 Added GITHUB_TOKEN constant to packages/core/src/constants.ts for better token management.
🔄 Modified createFetch function in packages/core/src/fetch.ts to return crossFetch directly if retryOn array is empty.
✨ Enhanced githubCreatePullRequestReview in packages/core/src/github.ts to create individual pull request review comments.
📊 Updated runTemplate function in packages/core/src/promptrunner.ts to map annotations to include the line number in the output.
🛠️ Improved relativePath function in packages/core/src/util.ts for better path handling.
📝 Added link function in packages/core/src/markdown.ts to create markdown links.

generated by genaiscript pr-describe

packages/core/src/github.ts

packages/core/src/annotations.ts

github-actions · 2024-06-02T05:21:56Z

packages/core/src/github.ts

    }
 }

 // https://docs.github.com/en/rest/pulls/pulls?apiVersion=2022-11-28#update-a-pull-request
 export async function githubUpsetPullRequest(
+    script: PromptScript,
    info: GithubConnectionInfo,
    text: string,
    commentTag: string
 ) {
    const { apiUrl, repository, issue } = info



The 'GITHUB_TOKEN' constant is being used as a secret key, but it should be using the 'token' from 'GithubConnectionInfo' which is already extracted from the environment.

generated by genaiscript pr-review-commit

github-actions · 2024-06-02T05:21:56Z

packages/core/src/github.ts

    const url = `${apiUrl}/repos/${repository}/issues/${issue}/comments`

+    body = appendGeneratedComment(script, info, body)
+
    if (commentTag) {
        const tag = `<!-- genaiscript ${commentTag} -->`


The 'appendGeneratedComment' function is being called without checking if 'info.runUrl' is defined, which could lead to incorrect markdown formatting if 'info.runUrl' is undefined.

generated by genaiscript pr-review-commit

github-actions · 2024-06-02T05:21:57Z

packages/core/src/github.ts

    info: GithubConnectionInfo,
    body: string,
-    commentTag?: string
+    commentTag: string


The 'appendGeneratedComment' function is being called without checking if 'info.runUrl' is defined, which could lead to incorrect markdown formatting if 'info.runUrl' is undefined.

generated by genaiscript pr-review-commit

github-actions · 2024-06-02T05:21:58Z

packages/core/src/github.ts

@@ -66,13 +83,13 @@ export async function githubUpsetPullRequest(
    const resGetJson = (await resGet.json()) as { body: string }
    let { body } = resGetJson
    if (!body) body = ""


The 'appendGeneratedComment' function is being called without checking if 'info.runUrl' is defined, which could lead to incorrect markdown formatting if 'info.runUrl' is undefined.

generated by genaiscript pr-review-commit

github-actions · 2024-06-02T05:36:45Z

The pull request introduces several changes across multiple files in a TypeScript project. Here's a high-level review of the changes:

CLI Command Updates: The run command in cli.ts is now set as the default command, and a new option --pull-request-reviews is added to create pull request reviews from annotations.
Functionality Enhancements: In run.ts, the new --pull-request-reviews option is handled to create pull request reviews if there are any annotations. Additionally, the handling of pull request comments and descriptions has been updated to use the new githubCreatePullRequestReviews function.
Annotation Parsing: In annotations.ts, the parsing of annotations has been refactored to use a record object instead of an array, which helps in deduplicating annotations. The relativePath function is now used to handle file paths.
Constants: In constants.ts, a new constant GITHUB_TOKEN is defined, which is likely used for authentication purposes.
Fetch Utility: In fetch.ts, a conditional return is added to bypass the retry wrapper if there are no conditions specified for retrying.
GitHub Integration: The github.ts file sees significant changes with new functions for creating pull request reviews and updating pull request descriptions. There's also improved error handling and verbose logging. The parseGHTokenFromEnv function is expanded to include additional environment variables related to GitHub Actions.
Markdown Utilities: In markdown.ts, a new link function is added to create markdown links.
Prompt Runner: In promptrunner.ts, the CSV to Markdown conversion for annotations now includes the line number directly from the annotation's range.
Utility Functions: In util.ts, the relativePath function is updated for better path handling, and the logError function now conditionally logs additional error details.

Overall, the changes seem to focus on enhancing the CLI tool's integration with GitHub, particularly around handling pull request reviews and comments. The refactoring and addition of new utility functions suggest an improvement in code quality and maintainability.

Concerns:

The changes are extensive and touch multiple core functionalities, which could introduce regressions if not thoroughly tested.
The reliance on environment variables for GitHub Actions integration means that proper configuration is crucial, and there's a potential for misconfiguration.
The changes assume the presence of certain environment variables (GITHUB_TOKEN, GITHUB_COMMIT_SHA, etc.), which may not be set in all environments.

Given the scope of the changes and assuming proper testing and configuration management practices are in place, the pull request looks good to me.

LGTM (Looks Good To Me).

generated by genaiscript pr-review

github-actions · 2024-06-02T05:42:03Z

packages/core/src/github.ts

@@ -12,6 +14,9 @@ export interface GithubConnectionInfo {
    ref?: string
    sha?: string
    issue?: number
+    runId?: string
+    runUrl?: string
+    commitSha?: string
 }

 export function parseGHTokenFromEnv(


The parseGHTokenFromEnv function has been updated to include runId, runUrl, and commitSha but the corresponding interface GithubConnectionInfo has not been updated to reflect these changes.

generated by genaiscript pr-review-commit

github-actions · 2024-06-02T05:42:04Z

packages/core/src/github.ts

    const url = `${apiUrl}/repos/${repository}/issues/${issue}/comments`

+    body = appendGeneratedComment(script, info, body)
+
    if (commentTag) {
        const tag = `<!-- genaiscript ${commentTag} -->`


The githubCreateIssueComment function is using a retryOn array that is empty, which means the fetch will not retry. If retries are intended, this array should include conditions for when to retry.

generated by genaiscript pr-review-commit

packages/core/src/github.ts

upload annotations

81b8bf1

microsoft deleted a comment from github-actions bot Jun 1, 2024

pelikhan added 4 commits June 1, 2024 19:50

put the review in comment, don't comment from ollama

97fce50

added commit comments

ef0aade

only review .ts files

dd29388

comment and review with pr-review

48feadf

microsoft deleted a comment from github-actions bot Jun 1, 2024

pelikhan added 13 commits June 1, 2024 20:17

consistent logging of gh calls

48055fe

more tuning of describe

6ac1431

include runid link in generated comment

b050ad1

more logging

e0c2f88

typo in run url

3930791

fix description slicing

a90189b

ensure relative path in diagnostics

8095010

more logging

d4165dc

and logging

be633a5

generate pull review comments

454b541

renamed option

11505d5

don't emit start_line if same lines

212414d

missing start_side

4b54950

pelikhan commented Jun 1, 2024

View reviewed changes

packages/core/src/github.ts Outdated Show resolved Hide resolved

only consider last commit_id

c10eeaf

pelikhan commented Jun 1, 2024

View reviewed changes

packages/core/src/github.ts Outdated Show resolved Hide resolved

pelikhan added 2 commits June 1, 2024 22:38

remove subject_type

13fc5c8

store pull request head sha

3e9055e

github-actions bot reviewed Jun 1, 2024

View reviewed changes

packages/core/src/github.ts Outdated Show resolved Hide resolved

github-actions bot reviewed Jun 1, 2024

View reviewed changes

packages/core/src/github.ts Show resolved Hide resolved

github-actions bot reviewed Jun 1, 2024

View reviewed changes

packages/core/src/github.ts Outdated Show resolved Hide resolved

pelikhan added 2 commits June 1, 2024 23:56

archive results

a34818c

tune review

77bcf2e