feat: Add GitHub integration #559

rsrbk · 2024-05-16T15:05:42Z

Description

The issue adds capability to build an agent that can solve specific issues in GitHub repos. It works by introducing a GitHubLoader which is a wrapper on top of PyGithub to do various operations with GitHub API like retrieving open issues or creating a pull request.

The new set up functions introduced in github_functions.py allows agent to interact with GitHubLoader and perform tasks specified by humans.

Lastly, the new prompt template allows to easily construct the correct prompt that will fix a specific issue in a github repo and submits a PR with the fix.

Motivation and Context

Progressing on the CAMEL roadmap which involves building software engineering agents.

Types of changes

What types of changes does your code introduce? Put an x in all the boxes that apply:

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds core functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Documentation (update in the documentation)
Example (update in the folder of example)

Implemented Tasks

Checklist

Go over all the following points, and put an x in all the boxes that apply.
If you are unsure about any of these, don't hesitate to ask. We are here to help!

I have read the CONTRIBUTION guide. (required)
My change requires a change to the documentation.
I have updated the tests accordingly. (required for a bug fix or a new feature)
I have updated the documentation accordingly.

coderabbitai · 2024-05-16T15:05:49Z

Important

Review Skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

Wendong-Fan · 2024-05-16T15:24:25Z

Thanks @rsrbk ! Seems we have some conflicts need to be solved, please do this when you have time

lightaime

Thanks @rsrbk for your first contribution! It is amazing. Left some comments.

camel/functions/github_functions.py

lightaime · 2024-05-17T11:19:42Z

camel/functions/github_functions.py

Could we also add functions like list all the repos, issues, files and PRs? We can do it in the next PR.

camel/functions/github_functions.py

examples/function_call/github_agent.py

pyproject.toml

test/functions/test_github_functions.py

lightaime

Thanks. I left some comments.

lightaime · 2024-05-22T13:29:14Z

camel/functions/github_functions.py

+import os
+from typing import List
+
+from github import Auth, Github


We don’t want to make PyGithub a mandatory dependency. Could we import it like how we do in other functions: https://github.com/camel-ai/camel/blob/master/camel/functions/search_functions.py. i.e. we import inside the functions.

camel/functions/github_functions.py

lightaime · 2024-05-22T13:56:38Z

camel/loaders/github_loader.py

+
+
+class GitHubLoaderIssue:
+    def __init__(self, title, body, number, file_path, file_content):


Type hinting and docstrings are still missing. BTW, why not just use dataclass : https://docs.python.org/3/library/dataclasses.html?

lightaime · 2024-05-22T14:00:41Z

camel/loaders/github_loader.py

+    def create_pull_request(
+        self, file_path, new_content, pr_title, commit_message
+    ):
+        branch_name = f"github-agent-update-{file_path.replace('/', '-')}"


This is still not fixed

lightaime · 2024-05-22T14:01:04Z

camel/loaders/github_loader.py

+        file = self.repo.get_contents(file_path)
+        self.repo.update_file(
+            file.path, commit_message, new_content, file.sha, branch=branch_name
+        )


This is still not fixed

camel/loaders/github_loader.py

pyproject.toml

test/functions/test_github_functions.py

Wendong-Fan

thanks for the contribution, left some comments. I'm a little bit confused with the scope, will we set github as one agent or just make it as tool/function for agent to call?

camel/functions/github_functions.py

camel/prompts/github.py

camel/types/enums.py

examples/function_call/github_agent.py

camel/toolkits/github_toolkit.py

lightaime

Looks amazing!!!

rsrbk requested review from lightaime, ocss884, yiyiyi0817 and Wendong-Fan May 16, 2024 15:05

Wendong-Fan linked an issue May 16, 2024 that may be closed by this pull request

[Feature Request] integrate github into CAMEL functions #544

Closed

2 tasks

Wendong-Fan added this to the Sprint 3 milestone May 16, 2024

Wendong-Fan added the New Feature label May 16, 2024

Wendong-Fan assigned rsrbk May 16, 2024

Wendong-Fan requested a review from a team May 16, 2024 15:25

lightaime reviewed May 17, 2024

View reviewed changes

Wendong-Fan changed the title ~~Add GitHub integration~~ feat: Add GitHub integration May 19, 2024

rsrbk added 8 commits May 20, 2024 11:46

WIP: GitHub integration

1caa6ca

Prettify console logs

8ad2c89

Add github function to support created a pull request

7ac41a5

Use function call to retrieve an issue from GitHub

369f914

unit test for retrieve_issue

e381924

add test_create_pull_request

cd3ec63

minor fixes

801f9d5

Move github example to function calls

4a7fdcb

rsrbk force-pushed the rsrbk/github-solve-issue branch from 382de58 to 4a7fdcb Compare May 20, 2024 10:48

rsrbk added 8 commits May 20, 2024 11:52

Update poetry.lock

4b28f17

Update functions api to be testable

9d265c4

fix functions

dfa389d

update tests

07a55c7

update comments

a890028

Update pyproject.toml

d48c286

Update poetry.lock

16b1100

add type hinting

cdec258

rsrbk added 11 commits May 20, 2024 16:04

Update pyproject.toml

1f02b07

update test repo path

3206f39

Update poetry.lock

9da973c

improve unit tests for github functions

132b009

add more tests

0c46554

add more tests

4d6295e

add more tests

49eb50d

improved tests for functions

b5b2fd9

fix remaining tests

25fd5ef

patching access token in tests

c056a70

patching access token in tests

77db30d

lightaime reviewed May 22, 2024

View reviewed changes

integrate github toolkit

cef1bcb

Wendong-Fan reviewed May 25, 2024

View reviewed changes

rsrbk and others added 12 commits May 25, 2024 16:25

Introduce GithubToolkit

65a6471

Update poetry.lock

b6de76d

documenting

be46e09

fix syntax errors

ea71de3

Merge branch 'master' into rsrbk/github-solve-issue

232f080

remove github as prompt template

804f792

remove unused files

2922d2c

fix docstream style

52995ac

fix docstream style

109d584

update lib name

ab97301

add space in pytoml

59ae7f0

add return types

8a47224

lightaime approved these changes May 25, 2024

View reviewed changes

fix types

4e838f2

lightaime merged commit dbbc995 into master May 25, 2024
6 checks passed

lightaime deleted the rsrbk/github-solve-issue branch May 25, 2024 21:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add GitHub integration #559

feat: Add GitHub integration #559

rsrbk commented May 16, 2024 •

edited

Loading

coderabbitai bot commented May 16, 2024 •

edited

Loading

Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

Wendong-Fan commented May 16, 2024

lightaime left a comment

lightaime May 17, 2024

lightaime left a comment

lightaime May 22, 2024

lightaime May 22, 2024

lightaime May 22, 2024

lightaime May 22, 2024

Wendong-Fan left a comment

lightaime left a comment



		class GitHubLoaderIssue:
		def __init__(self, title, body, number, file_path, file_content):

feat: Add GitHub integration #559

feat: Add GitHub integration #559

Conversation

rsrbk commented May 16, 2024 • edited Loading

Description

Motivation and Context

Types of changes

Implemented Tasks

Checklist

coderabbitai bot commented May 16, 2024 • edited Loading

Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

Wendong-Fan commented May 16, 2024

lightaime left a comment

Choose a reason for hiding this comment

lightaime May 17, 2024

Choose a reason for hiding this comment

lightaime left a comment

Choose a reason for hiding this comment

lightaime May 22, 2024

Choose a reason for hiding this comment

lightaime May 22, 2024

Choose a reason for hiding this comment

lightaime May 22, 2024

Choose a reason for hiding this comment

lightaime May 22, 2024

Choose a reason for hiding this comment

Wendong-Fan left a comment

Choose a reason for hiding this comment

lightaime left a comment

Choose a reason for hiding this comment

rsrbk commented May 16, 2024 •

edited

Loading

coderabbitai bot commented May 16, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)