Skip to content

Commit ff4b49f

Browse files
hendisantikaclaude
andcommitted
📝 docs: add CI/CD deployment section to README
Document GitHub Actions workflows, required repository variables (DEV_ENV_FILE, DEV_GROUPS_JSON), and repository secrets. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 62630a4 commit ff4b49f

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -607,6 +607,31 @@ docker stop pythonid-bot
607607
docker restart pythonid-bot
608608
```
609609

610+
## CI/CD Deployment
611+
612+
The project uses GitHub Actions for automated testing and deployment:
613+
614+
1. **Python Code Checks** (`python-checks.yml`) — Runs ruff lint and pytest across Python 3.11–3.14 on every push
615+
2. **Deploy to Dev Server** (`deploy-dev.yml`) — Builds Docker image, pushes to Docker Hub, and deploys to the dev server
616+
617+
### GitHub Repository Variables
618+
619+
The deployment workflow writes configuration files to the server from GitHub repository variables (**Settings > Secrets and variables > Actions > Variables**):
620+
621+
| Variable | Description |
622+
|----------|-------------|
623+
| `DEV_ENV_FILE` | Contents of the `.env` file (bot token, database path, logging settings) |
624+
| `DEV_GROUPS_JSON` | Contents of `groups.json` for multi-group configuration |
625+
626+
### GitHub Repository Secrets
627+
628+
| Secret | Description |
629+
|--------|-------------|
630+
| `DOCKERHUB_USERNAME` | Docker Hub username for image push |
631+
| `DOCKERHUB_TOKEN` | Docker Hub access token |
632+
| `DEV_SSH_PRIVATE_KEY` | SSH private key for server access |
633+
| `DEV_SSH_KNOWN_HOSTS` | SSH known hosts entry for the server |
634+
610635
## License
611636

612637
MIT

0 commit comments

Comments
 (0)