Skip to content

Commit 4631cd6

Browse files
committed
update README.md
1 parent 29b7cf1 commit 4631cd6

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

β€ŽREADME.md

+9-6
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# alert-menta
22
An innovative tool πŸš€ for real-time analysis and management of Issues' alerts. πŸ” It identifies alert causes, proposes actionable solutions, πŸ’‘and detailed reports. πŸ“ˆ
33
Designed for developers πŸ‘¨β€πŸ’», managers πŸ“‹, and IT teams .πŸ’» Alert-menta enhances productivity and software quality. 🌟
4-
54
## Overview of alert-menta
65
### The purpose of alert-menta
76
We reduce the burden of system failure response using LLM.
@@ -16,7 +15,7 @@ You can receive support for failure handling that is completed within GitHub.
1615
- Selectable LLM models (OpenAI, VertexAI)
1716
- Extensible prompt text
1817
- Multilingual support
19-
18+
- Allows dialogue that includes images.
2019
## How to Use
2120
Alert-menta is intended to be run on GitHub Actions.
2221
### 1. Prepare GitHub PAT
@@ -43,16 +42,19 @@ Execute commands on the Issue. Run commands with a backslash at the beginning (e
4342
It contains information such as the LLM model to use, system prompt text for each command, etc. The `.alert-menta.user.yaml` in this repository is a template. The contents are as follows:
4443
```
4544
system:
46-
debug:
45+
debug:
4746
log_level: debug
47+
4848
ai:
4949
provider: "openai" # "openai" or "vertexai"
5050
openai:
51-
model: "gpt-3.5-turbo" # Check the list of available models by curl https://api.openai.com/v1/models -H "Authorization: Bearer $OPENAI_API_KEY"
51+
model: "gpt-4o-mini-2024-07-18" # Check the list of available models by `curl https://api.openai.com/v1/models -H "Authorization: Bearer $OPENAI_API_KEY"`
52+
5253
vertexai:
5354
project: "<YOUR_PROJECT_ID>"
5455
location: "us-central1"
5556
model: "gemini-1.5-flash-001"
57+
5658
commands:
5759
- describe:
5860
description: "Generate a detailed description of the Issue."
@@ -62,7 +64,8 @@ ai:
6264
system_prompt: "The following is the GitHub Issue and comments on it. Please identify the issues that need to be resolved based on the contents of the Issue and provide three suggestions for improvement.\n"
6365
- ask:
6466
description: "Answer free-text questions."
65-
system_prompt: "The following is the GitHub Issue and comments on it. Based on the content, provide a detailed response to the following question:\n"
67+
system_prompt: "The following is the GitHub Issue and comments on it. Based on the content provide a detailed response to the following question:\n"
68+
6669
```
6770
Specify the LLM to use with `ai.provider`.
6871
You can change the system prompt with `commands.{command}.system_prompt`.
@@ -92,7 +95,7 @@ jobs:
9295
run: |
9396
curl -sLJO -H 'Accept: application/octet-stream' \
9497
"https://${{ secrets.GH_TOKEN }}@api.github.com/repos/3-shake/alert-menta/releases/assets/$( \
95-
curl -sL "https://${{ secrets.GH_TOKEN }}@api.github.com/repos/3-shake/alert-menta/releases/tags/v0.1.0" \
98+
curl -sL "https://${{ secrets.GH_TOKEN }}@api.github.com/repos/3-shake/alert-menta/releases/tags/v0.1.2" \
9699
| jq '.assets[] | select(.name | contains("Linux_x86")) | .id')"
97100
tar -zxvf alert-menta_Linux_x86_64.tar.gz
98101

0 commit comments

Comments
Β (0)