Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/flavienbwk/repochat-action
Deploy an AI-powered chatbot for your repo in under 2 minutes.
https://github.com/flavienbwk/repochat-action
ai-ops chatbot devops github-actions llm llm-ops
Last synced: 13 days ago
JSON representation
Deploy an AI-powered chatbot for your repo in under 2 minutes.
- Host: GitHub
- URL: https://github.com/flavienbwk/repochat-action
- Owner: flavienbwk
- Created: 2024-08-25T05:09:42.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-09-13T03:53:15.000Z (3 months ago)
- Last Synced: 2024-11-27T06:05:33.101Z (16 days ago)
- Topics: ai-ops, chatbot, devops, github-actions, llm, llm-ops
- Language: JavaScript
- Homepage: https://gharepochatactionxfabjtdg-gha-repochat-action.functions.fnc.fr-par.scw.cloud/
- Size: 1.1 MB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-llm-devops - Repochat Action
- awesome-llm-devops - Repochat Action
README
# Repochat Action
[](https://github.com/flavienbwk/repochat-action/actions/workflows/push-deploy.yml)
[](https://github.com/flavienbwk/repochat-action/releases/latest)
[](https://opensource.org/licenses/MIT)
> [!WARNING]
> This project is in early development and may contain bugs. Use with caution in production environments.
Chat with your repo in under 2 minutes using GitHub Actions on [supported Cloud providers](#supported-cloud-providers).
Features:
- :sparkles: A nice web UI
- :octocat: Available as a GitHub Action
- :arrows_counterclockwise: Sateless ingestion via API
- :floppy_disk: Optional state persisted to PostgreSQL or ChromaDB
- :closed_lock_with_key: Optional password on web UI
## Requirements
- A [supported cloud provider](#supported-cloud-providers) credentials ;
- An [OpenAI](https://openai.com/api/) API key.
## Usage for GitHub Actions
Easily add RepoChat to your project using GitHub Actions:
```yaml
name: "Deploy Repochat for this repo"
on:
push:
branches:
- main
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: flavienbwk/repochat-action@v0
name: 'Deploy Repochat'
id: deploy_repochat
with:
# All parameters not explicitly marked as "optional" are required
dirs_to_scan: "." # comma-separated glob dirs to analyze
interface_password: ${{ secrets.INTERFACE_PASSWORD }} # optional
openai_api_key: ${{ secrets.OPENAI_API_KEY }}
openai_model_type_inference: "gpt-4o-mini"
openai_model_type_embedding : "text-embedding-3-small"
provider_name: 'scaleway'
provider_key_id: ${{ secrets.PROVIDER_KEY_ID }}
provider_key_secret: ${{ secrets.PROVIDER_KEY_SECRET }}
provider_project_id: ${{ secrets.PROVIDER_PROJECT_ID }}
provider_default_region: 'fr-par'
provider_default_zone: 'fr-par-2'
- name: Get repochat domain
run: echo "DOMAIN=${{ steps.deploy_repochat.outputs.domain }}" >> $GITHUB_OUTPUT
id: repochat_domain
```
| Name | Required | Secret | Description |
| --------------------------- | -------- | ------ | -------------------------------------------------------------------------------------------------------- |
| dirs_to_scan | Yes | No | Comma-separated glob directories to analyze |
| openai_api_key | Yes | Yes | OpenAI API key for authentication |
| openai_model_type_inference | Yes | No | OpenAI model type for inference (e.g., "gpt-4o-mini") |
| openai_model_type_embedding | Yes | No | OpenAI model type for embedding (e.g., "text-embedding-3-small") |
| provider_name | Yes | No | Name of the cloud provider (e.g., 'scaleway') |
| provider_key_id | Yes | Yes | Cloud provider API key ID |
| provider_key_secret | Yes | Yes | Cloud provider API key secret |
| provider_project_id | Yes | Yes | Cloud provider project ID |
| provider_default_region | Yes | No | Default region for the cloud provider (e.g., 'fr-par') |
| provider_default_zone | Yes | No | Default zone for the cloud provider (e.g., 'fr-par-2') |
| interface_password | No | Yes | Optional password for the interface |
| pg_connection_string | No | Yes | Enables storage to external PG DB (format: 'postgresql://username:password@hostname:port/database_name') |
| cpu_limit | No | No | Default to 1000 (1 vCPU). Capabilities depend on the Cloud provider. |
| memory_limit | No | No | Default to 1024. Capabilities depend on the Cloud provider. |
| min_scale | No | No | Default to 1. Must be left to 1 if not using the PG connection. |
| max_scale | No | No | Default to 1. Must be left to 1 if not using the PG connection. |
Get a practical implementation example with [`.github/workflows/push-deploy.yml`](./.github/workflows/push-deploy.yml#L76).
You can restrict your OpenAI API key permissions to:
- Models: `Read`
- Model capabilities: `Write`
### Supported Cloud providers
- **[Scaleway](https://www.scaleway.com/en/)**
- Refer to [Scaleway's documentation to generate API keys](https://www.scaleway.com/en/docs/identity-and-access-management/iam/how-to/create-api-keys/).
- Additional required parameters:
```txt
provider_name: 'scaleway'
provider_key_id: ${{ secrets.PROVIDER_KEY_ID }}
provider_key_secret: ${{ secrets.PROVIDER_KEY_SECRET }}
provider_project_id: ${{ secrets.PROVIDER_PROJECT_ID }}
provider_default_region: 'fr-par' # example
provider_default_zone: 'fr-par-2' # example
```
- Policies: ContainersFullAccess, ServerlessJobsFullAccess, FunctionsFullAccess
## Other deployments
### Deploy with Docker
👉 Deploy locally as a stateless API...
1. Copy and update env variables
```bash
cp .env.example .env
```
2. Run the Docker container
```bash
docker compose up --build -d
```
3. Inject data taking example on the [Python](./scripts/ingest-docs-api.py) or [JS](./scripts/ingest-docs-api.js) scripts
4. Access the app at `http://localhost:3001`
## Development
👉 Run RepoChat for development...
1. Clone this repo
```bash
[email protected]:flavienbwk/repochat-action.git
```
2. Copy and update env variables
```bash
cp .env.example .env
```
3. Run the local stack
```bash
make dev
```
4. Access the app at `http://127.0.0.1:3000`
## Release Action
1. Increase repochat's version in `./package.json`
2. Run build and commit latest edits:
```bash
npm run build
# git add && git commit && git push...
```
3. Merge on `main`
This will create a release based on `package.json` and push the `:latest` Docker image.
## Why not use Vercel ?
Vercel is very limited when it comes to deploying everything but JS. First, ChromaDB (and any sqlite-based library) [is not supported in Vercel](https://vercel.community/t/is-vercel-incompatible-with-chromadb-sqlite/787). Then, this project uses a FastAPI Python API that requires more storage than [Vercel's 250MB bundle limit](https://vercel.com/docs/functions/runtimes#bundle-size-limits).