Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fahmifareed/summarize-github--issue
Perform automatic summarization for GitHub Issues. The summarization is triggered when the user send the trigger word in the comment.
https://github.com/fahmifareed/summarize-github--issue
Last synced: about 1 month ago
JSON representation
Perform automatic summarization for GitHub Issues. The summarization is triggered when the user send the trigger word in the comment.
- Host: GitHub
- URL: https://github.com/fahmifareed/summarize-github--issue
- Owner: fahmifareed
- Created: 2024-10-07T07:53:38.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-07T07:54:02.000Z (3 months ago)
- Last Synced: 2024-11-17T12:46:16.820Z (about 2 months ago)
- Language: Rust
- Size: 9.19 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
#
Summarize GitHub Issues with a Comment
Can't spare the time to peruse lengthy issue posts? Let this bot lend a hand by summarizing the current issue on your GitHub repository and posting a recap as a comment. It could save you time and boost productivity.
## Usage
To use the bot, comment on an issue with the trigger phrase you define. You can also specify the minimum number of comments required on an issue before the bot activates.
If you don't change the template, by default the bot will be triggered when an issue with 5 or more comments receives a comment containing @flows_summarize.
## Deploy on your own repo
1. Create a bot from the template
2. Add your OpenAI API key
3. Configure the bot to summarize issues on a specified GitHub repo
### 0 Prerequisites
You will need to bring your own [OpenAI API key](https://openai.com/blog/openai-api). If you do not already have one, [sign up here](https://platform.openai.com/signup).
You will also need to sign into [flows.network](https://flows.network/) using your GitHub account. It is free to join.
### 1 Create a bot from the template
[**Just click here**](https://flows.network/flow/createByTemplate/summarize-github--issue)
Review the `trigger_phrase` and `n_comments`variables.
* `trigger_phrase`is the magic words you type in a issue comment to manually activate the bot. The default is `@flows_summarize`.
* `n_comments` specifies the minimum number of comments required on an issue before the bot can activate. The default is `5`.
Click on the **Create and Build** button.
### 2 Add your OpenAI API key
You will now set up OpenAI integration. Click on **Connect**, enter your key and give it a name.
[
](https://user-images.githubusercontent.com/45785633/222973214-ecd052dc-72c2-4711-90ec-db1ec9d5f24e.png)
Once added, close the tab and return to flows.network. Click on **Continue**.
### 3 Configure the bot to summarize issues on a specified GitHub repo
Next, you will tell the bot which GitHub repo it needs to monitor for issues to review.
* `github_owner`: The GitHub org that owns the repo *you want to deploy the bot on*.
* `github_repo` : The specific repo *you want the bot to monitor*.
| Name | Value |
|----------------|---------------------|
| `github_owner` | WasmEdge |
| `github_repo` | wasmedge_hyper_demo |
> For example, to deploy this bot on the `WasmEdge/wasmedge_hyper_demo repo`, you'd set `github_owner` to `WasmEdge` and `github_repo` to `wasmedge_hyper_demo`.
Click **Connect** or **+ Add new authentication** button to grant [flows.network](https://flows.network/) access to the GitHub repo to deploy the 🤖.
[
](https://github.com/flows-network/github-pr-summary/assets/45785633/6cefff19-9eeb-4533-a20b-03c6a9c89473)
Once done, close the popup window and return to the flow.network page. 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 summarize issues! It will be summoned by commenting trigger phrase on the issues.