Update code defaults and docs

juntao · juntao · commit de8a7ef6b96d · 2024-07-13T01:44:06.000Z
Signed-off-by: Michael Yuan &lt;michael@secondstate.io&gt;
diff --git a/README.md b/README.md
@@ -31,48 +31,66 @@ This bot **summarizes commits in the PR**. Alternatively, you can use [this bot]
 
 ## How it works
 
-This flow function (or &#129302;) will be triggered when a new PR is raised in the designated GitHub repo. The flow function collects the content in the PR, and asks ChatGPT/4 to review and summarize it. The result is then posted back to the PR as a comment. The flow functions are written in Rust and run in hosted [WasmEdge Runtimes](https://github.com/wasmedge) on [flows.network](https://flows.network/).
+This flow function will be triggered when a new PR is raised in the designated GitHub repo. The flow function collects the content in the PR, and asks ChatGPT/4 to review and summarize it. The result is then posted back to the PR as a comment. The flow functions are written in Rust and run in hosted [WasmEdge Runtimes](https://github.com/wasmedge) on [flows.network](https://flows.network/).
 
-* The code review comment is updated automatically every time a new commit is pushed to this PR.
-* A new code review could be triggered when someone says a magic *trigger phrase* in the PR's comments section. The default trigger phrase is "flows summarize".
+* The PR summary comment is updated automatically every time a new commit is pushed to this PR.
+* A new summary could be triggered when someone says a magic *trigger phrase* in the PR's comments section. The default trigger phrase is "flows summarize".
 
-## Deploy your own code review bot in 2 simple steps
+## Deploy your own code review bot in 3 simple steps
 
-1. Create a bot from a template
-2. Configure the bot to review PRs on a specified GitHub repo
+1. Create a bot from your own GitHub repo
+2. Configure the bot to review PRs
+3. Connect to GitHub for access to the target repo
 
 ### 0 Prerequisites
 
 You will also need to sign into [flows.network](https://flows.network/) from your GitHub account. It is free.
 
-### 1 Create a bot from a template
+### 1 Create a bot from your own GitHub repo
 
-[**Just click here**](https://flows.network/flow/createByTemplate/Summarize-Pull-Request)
+Just fork this repo to your own GitHub account.
 
-Review the `trigger_phrase` variable. It is the magic words you type in a PR comment to manually summon the review bot.
+Then, from [flows.network](https://flows.network/), you can "Create a Flow" and select your forked repo.
+It will create a flow function based on the code in your forked repo.
 
-Click on the **Create and Build** button.
+Click on the "Advanced" button to see configuration options for the flow function.
 
-### 2 Configure the bot to access GitHub
+### 2 Configure the bot to review PRs
+
+<img src="https://raw.githubusercontent.com/flows-network/github-pr-summary/main/images/config.png" width="450"/>
 
 Next, you will tell the bot which GitHub repo it needs to monitor for upcoming PRs to review.
 
-* `github_owner`: GitHub org for the repo *you want to deploy the &#129302; on*.
-* `github_repo` : GitHub repo *you want to deploy the &#129302; on*.
+* `github_owner`: GitHub org for the repo *you want to review PRs*
+* `github_repo` : GitHub repo *you want to review PRs*
+* `trigger_phrase` : The magic words to write in a PR comment to summon the bot. It defaults to "flows summarize".
 
 > Let's see an example. You would like to deploy the bot to review code in PRs on `WasmEdge/wasmedge_hyper_demo` repo. Here `github_owner = WasmEdge` and `github_repo = wasmedge_hyper_demo`.
 
-Click on the **Connect** or **+ Add new authentication** button to give the function access to the GitHub repo to deploy the &#129302;. You'll be redirected to a new page where you must grant [flows.network](https://flows.network/) permission to the repo.
+And the LLM API service you want to use to review the PRs.
+
+* `llm_api_endpoint` : The OpenAI compatible API service endpoint for the LLM to conduct code reviews.
+* `llm_model_name` : The model name required by the API service.
+* `llm_api_key` : Optional: The API key if required by the LLM service provider.
+
+Click on the **Build** button.
+
+### 3 Connect to GitHub for access to the target repo
+
+Finally, the GitHub repo will need to give you access so that the flow function can
+access and review its PRs! In this next screen, you will connect to GitHub and authorize access.
+
+Click on the **Connect** or **+ Add new authentication** button to give the function access to the GitHub repo. You'll be redirected to a new page where you must grant [flows.network](https://flows.network/) permission to the repo.
 
-[<img width="450" alt="image" src="https://github.com/flows-network/github-pr-summary/assets/45785633/6cefff19-9eeb-4533-a20b-03c6a9c89473">](https://github.com/flows-network/github-pr-summary/assets/45785633/6cefff19-9eeb-4533-a20b-03c6a9c89473)
+<img src="https://raw.githubusercontent.com/flows-network/github-pr-summary/main/images/github_integration.png" width="450"/>
 
 Close the tab and go back to the flow.network page once you are done. Click on **Deploy**.
 
 ### Wait for the magic!
 
 This is it! You are now on the flow details page waiting for the flow function to build. As soon as the flow's status became `running`, the bot is ready to give code reviews! The bot is summoned by every new PR, every new commit, as well as magic words (i.e., `trigger_phrase`) in PR comments.
 
-[<img width="450" alt="image" src="https://user-images.githubusercontent.com/45785633/229329247-16273aec-f89b-4375-bf2b-4ffce5e35a33.png">](https://user-images.githubusercontent.com/45785633/229329247-16273aec-f89b-4375-bf2b-4ffce5e35a33.png)
+<img src="https://raw.githubusercontent.com/flows-network/github-pr-summary/main/images/success.png" width="450"/>
 
 ## FAQ
 
diff --git a/src/github-pr-summary.rs b/src/github-pr-summary.rs
@@ -39,23 +39,9 @@ async fn handler(payload: EventPayload) {
     let owner = env::var("github_owner").unwrap_or("juntao".to_string());
     let repo = env::var("github_repo").unwrap_or("test".to_string());
     let trigger_phrase = env::var("trigger_phrase").unwrap_or("flows summarize".to_string());
-    let llm_api_endpoint = env::var("llm_api_endpoint").unwrap_or("https://codestral-01-22b.us.gaianet.network/v1".to_string());
-    let llm_model_name = env::var("llm_model_name").unwrap_or("Codestral-22B-v0.1-hf-Q5_K_M".to_string());
-
-    /*
-    if let EventPayload::IssueCommentEvent(e) = payload {
-        let comment_id = e.comment.id.0;
-
-        // installed app login
-        let octo = get_octo(&GithubLogin::Provided(String::from("some_login")));
-
-        let _reaction = octo
-            .issues("some_owner", "some_repo")
-            .create_comment_reaction(comment_id, ReactionContent::Rocket)
-            .await
-            .unwrap();
-    };
-    */
+    let llm_api_endpoint = env::var("llm_api_endpoint").unwrap_or("https://api.openai.com/v1".to_string());
+    let llm_model_name = env::var("llm_model_name").unwrap_or("gpt-4o".to_string());
+    let llm_api_key = env::var("llm_api_key").unwrap_or("LLAMAEDGE".to_string());
 
     let mut new_commit : bool = false;
     let (title, pull_number, _contributor) = match payload {
@@ -170,6 +156,7 @@ async fn handler(payload: EventPayload) {
     let chat_id = format!("PR#{pull_number}");
     let system = &format!("You are an experienced software developer. You will act as a reviewer for a GitHub Pull Request titled \"{}\". Please be as concise as possible while being accurate.", title);
     let mut lf = LLMServiceFlows::new(&llm_api_endpoint);
+    lf.set_api_key(&llm_api_key);
     // lf.set_retry_times(3);
 
     let mut reviews: Vec<String> = Vec::new();
