docs: Add documentation for SourceAnt#67
Conversation
![sourceant[bot]](https://avatars.githubusercontent.com/in/1161781?s=60&v=4){kind=small}
| ```env | ||
| GITHUB_APP_ID=123456 | ||
| GITHUB_APP_PRIVATE_KEY_PATH=/path/to/private-key.pem | ||
| GITHUB_SECRET=your_webhook_secret |
There was a problem hiding this comment.
There is a naming inconsistency between step 1 and step 4. In step 1, you refer to GITHUB_SECRET, but in the environment block in step 4, you use GITHUB_WEBHOOK_SECRET (implicitly, though it shows GITHUB_SECRET again). In configuration.md, the variable is named GITHUB_WEBHOOK_SECRET. This should be consistent to avoid configuration errors.
| GITHUB_SECRET=your_webhook_secret | |
| GITHUB_WEBHOOK_SECRET=your_webhook_secret |
| Install Python dependencies: | ||
|
|
||
| ```bash | ||
| docker compose exec app pip install -r requirements.txt |
There was a problem hiding this comment.
Typically, production-ready Docker images already have dependencies installed. Running pip install inside a running container via exec is an anti-pattern for Docker usage and will lose changes if the container is recreated. If the image is meant for development, this should be part of the Dockerfile or a volume mount.
| docker compose exec app pip install -r requirements.txt | |
| # Dependencies are pre-installed in the Docker image. | |
| # If adding new ones locally: | |
| docker compose build |
nfebe
left a comment
nfebe
left a comment
There was a problem hiding this comment.
The documentation is heavily focused on development configuration instead of "use configuration" (not a thing but should be clear)
|
|
||
| ### Docker Compose | ||
|
|
||
| The recommended deployment method uses Docker Compose. The compose file includes the API server, a Redis queue, and a PostgreSQL database. |
There was a problem hiding this comment.
The recommended deployment strategy is via containerization not Docker compose so enhance this to be around containers/images.
| GITHUB_WEBHOOK_SECRET=your_webhook_secret | ||
| GITHUB_APP_ID=your_github_app_id | ||
| GITHUB_APP_PRIVATE_KEY_PATH=/path/to/private-key.pem | ||
| GITHUB_SECRET=your_github_secret |
There was a problem hiding this comment.
The variable GITHUB_SECRET is used here, but in the GitHub App setup and other sections it refers to the Webhook Secret. To avoid confusion with the GitHub OAuth App Secret or other tokens, it is better to use GITHUB_WEBHOOK_SECRET consistently as established in the review of github-app.md.
| GITHUB_SECRET=your_github_secret | |
| GITHUB_WEBHOOK_SECRET=your_github_webhook_secret |
| 1. Go to your repository **Settings > Webhooks > Add webhook**. | ||
| 2. **Payload URL:** Your server's `/webhook` endpoint. | ||
| 3. **Content type:** `application/json`. | ||
| 4. **Secret:** Your `GITHUB_SECRET`. |
There was a problem hiding this comment.
The GitHub App documentation mentions using GITHUB_SECRET for the webhook secret, but the configuration guide and the code (implied by LiteLLM/FastAPI patterns) usually prefer GITHUB_WEBHOOK_SECRET. For consistency with the fix in configuration.md, update this reference.
| 4. **Secret:** Your `GITHUB_SECRET`. | |
| 4. Secret: Your `GITHUB_WEBHOOK_SECRET`. |
| GITHUB_APP_PRIVATE_KEY_PATH=/path/to/private-key.pem | ||
| GITHUB_SECRET=your_github_secret |
There was a problem hiding this comment.
In Step 1 of github-app.md, the variable is referred to as GITHUB_SECRET. For consistency and to avoid confusion with the GITHUB_WEBHOOK_SECRET defined on line 26, it is better to ensure the nomenclature matches across files. Based on the usage in other files, this appears to be the GitHub Client Secret.
| GITHUB_APP_PRIVATE_KEY_PATH=/path/to/private-key.pem | |
| GITHUB_SECRET=your_github_secret | |
| GITHUB_CLIENT_SECRET=your_github_client_secret |
|
|
||
| ### Next Steps | ||
|
|
||
| - Read [Usage](usage.md) to understand the review workflow. |
There was a problem hiding this comment.
The documentation points to usage.md, but that file is not included in the docs.json manifest nor provided in this PR. This will result in a 404/broken link in the documentation site.
| - Read [Usage](usage.md) to understand the review workflow. | |
| - Read [Quick Start](quick-start.md) to understand the review workflow. |
| ```env | ||
| GITHUB_APP_ID=your_github_app_id | ||
| GITHUB_APP_PRIVATE_KEY_PATH=/path/to/private-key.pem | ||
| GITHUB_SECRET=your_webhook_secret |
There was a problem hiding this comment.
Consistency: As noted in the GitHub App setup guide review, use GITHUB_WEBHOOK_SECRET instead of GITHUB_SECRET to align with the rest of the application's environment variable naming.
| GITHUB_SECRET=your_webhook_secret | |
| GITHUB_WEBHOOK_SECRET=your_webhook_secret |
|
|
||
| ### Next Steps | ||
|
|
||
| - Read [Usage](usage.md) to understand the review workflow. |
There was a problem hiding this comment.
Dead link: The 'usage.md' file is mentioned in the sidebar or text but is not present in the current documentation manifest or file list. This will result in a 404 error.
| - Read [Usage](usage.md) to understand the review workflow. | |
| - Read [Configuration](configuration.md) to understand the review workflow. |
| If you are not using the GitHub App flow, you can configure a webhook directly on a repository: | ||
|
|
||
| 1. Go to your repository **Settings > Webhooks > Add webhook**. | ||
| 2. **Payload URL:** Your server's `/webhook` endpoint. |
There was a problem hiding this comment.
The path /webhook contradicts the setup instructions in step 1 which suggested /api/github/webhooks. It's better to keep the endpoint path consistent throughout the guide to avoid user confusion.
2 participants
Add docs.json manifest and 5 markdown files covering quick start, configuration, GitHub App setup, repo management, and deployment.