xiaxinhang/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-07-04 21:00:40 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1798 from seohyun-lee/docs/usage-guide

Browse Source 
Correct typos in documentation and log messages
This commit is contained in:
Tal
2025-05-21 07:38:22 +03:00
committed by GitHub
parent 7821e71b17 25b807f71c
commit 199b463eaa
7 changed files with 11 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/docs/installation/github.md
View File

@ -193,9 +193,8 @@ For example: `GITHUB.WEBHOOK_SECRET` --> `GITHUB__WEBHOOK_SECRET`
3. Push image to ECR 3. Push image to ECR
```shell ```shell
docker tag codiumai/pr-agent:serverless <AWS_ACCOUNT>.dkr.ecr.<AWS_REGION>.amazonaws.com/codiumai/pr-agent:serverless
docker tag codiumai/pr-agent:serverless <AWS_ACCOUNT>.dkr.ecr.<AWS_REGION>.amazonaws.com/codiumai/pr-agent:serverless docker push <AWS_ACCOUNT>.dkr.ecr.<AWS_REGION>.amazonaws.com/codiumai/pr-agent:serverless
docker push <AWS_ACCOUNT>.dkr.ecr.<AWS_REGION>.amazonaws.com/codiumai/pr-agent:serverless
``` ```
4. Create a lambda function that uses the uploaded image. Set the lambda timeout to be at least 3m. 4. Create a lambda function that uses the uploaded image. Set the lambda timeout to be at least 3m.

2
docs/docs/usage-guide/additional_configurations.md
View File

@ -50,7 +50,7 @@ glob = ['*.py']
And to ignore Python files in all PRs using `regex` pattern, set in a configuration file: And to ignore Python files in all PRs using `regex` pattern, set in a configuration file:
``` ```
[regex] [ignore]
regex = ['.*\.py$'] regex = ['.*\.py$']
``` ```

2
docs/docs/usage-guide/configuration_options.md
View File

@ -5,7 +5,7 @@ See the [Tools Guide](https://qodo-merge-docs.qodo.ai/tools/) for a detailed des
There are three main ways to set persistent configurations: There are three main ways to set persistent configurations:
1. [Wiki](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#wiki-configuration-file)configuration page 💎 1. [Wiki](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#wiki-configuration-file) configuration page 💎
2. [Local](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#local-configuration-file) configuration file 2. [Local](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#local-configuration-file) configuration file
3. [Global](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#global-configuration-file) configuration file 💎 3. [Global](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#global-configuration-file) configuration file 💎

2
pr_agent/git_providers/azuredevops_provider.py
View File

@ -618,7 +618,7 @@ class AzureDevopsProvider(GitProvider):
return pr_id return pr_id
except Exception as e: except Exception as e:
if get_settings().config.verbosity_level >= 2: if get_settings().config.verbosity_level >= 2:
get_logger().info(f"Failed to get pr id, error: {e}") get_logger().info(f"Failed to get PR id, error: {e}")
return "" return ""
def publish_file_comments(self, file_comments: list) -> bool: def publish_file_comments(self, file_comments: list) -> bool:

2
pr_agent/git_providers/github_provider.py
View File

@ -96,7 +96,7 @@ class GithubProvider(GitProvider):
parsed_url = urlparse(given_url) parsed_url = urlparse(given_url)
repo_path = (parsed_url.path.split('.git')[0])[1:] # /<owner>/<repo>.git -> <owner>/<repo> repo_path = (parsed_url.path.split('.git')[0])[1:] # /<owner>/<repo>.git -> <owner>/<repo>
if not repo_path: if not repo_path:
get_logger().error(f"url is neither an issues url nor a pr url nor a valid git url: {given_url}. Returning empty result.") get_logger().error(f"url is neither an issues url nor a PR url nor a valid git url: {given_url}. Returning empty result.")
return "" return ""
return repo_path return repo_path
except Exception as e: except Exception as e:

4
pr_agent/tools/pr_description.py
View File

@ -199,7 +199,7 @@ class PRDescription:
async def _prepare_prediction(self, model: str) -> None: async def _prepare_prediction(self, model: str) -> None:
if get_settings().pr_description.use_description_markers and 'pr_agent:' not in self.user_description: if get_settings().pr_description.use_description_markers and 'pr_agent:' not in self.user_description:
get_logger().info("Markers were enabled, but user description does not contain markers. skipping AI prediction") get_logger().info("Markers were enabled, but user description does not contain markers. Skipping AI prediction")
return None return None
large_pr_handling = get_settings().pr_description.enable_large_pr_handling and "pr_description_only_files_prompts" in get_settings() large_pr_handling = get_settings().pr_description.enable_large_pr_handling and "pr_description_only_files_prompts" in get_settings()
@ -707,7 +707,7 @@ class PRDescription:
pr_body += """</tr></tbody></table>""" pr_body += """</tr></tbody></table>"""
except Exception as e: except Exception as e:
get_logger().error(f"Error processing pr files to markdown {self.pr_id}: {str(e)}") get_logger().error(f"Error processing PR files to markdown {self.pr_id}: {str(e)}")
pass pass
return pr_body, pr_comments return pr_body, pr_comments

4
pr_agent/tools/pr_reviewer.py
View File

@ -317,7 +317,9 @@ class PRReviewer:
get_logger().exception(f"Failed to remove previous review comment, error: {e}") get_logger().exception(f"Failed to remove previous review comment, error: {e}")
def _can_run_incremental_review(self) -> bool: def _can_run_incremental_review(self) -> bool:
"""Checks if we can run incremental review according the various configurations and previous review""" """
Checks if we can run incremental review according the various configurations and previous review.
"""
# checking if running is auto mode but there are no new commits # checking if running is auto mode but there are no new commits
if self.is_auto and not self.incremental.first_new_commit_sha: if self.is_auto and not self.incremental.first_new_commit_sha:
get_logger().info(f"Incremental review is enabled for {self.pr_url} but there are no new commits") get_logger().info(f"Incremental review is enabled for {self.pr_url} but there are no new commits")