Skip to content

Commit 54bfa37

Browse files
cfsmp3claude
andauthored
docs: update deployment README to reflect auto-deploy (#443)
- Update overview to mention automatic deployment - Update deployment section with actual auto-deploy flow - Remove outdated migration note from monitoring section Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
1 parent aa45761 commit 54bfa37

1 file changed

Lines changed: 9 additions & 10 deletions

File tree

deployment/README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This directory contains the production deployment configuration for CCSync.
66

77
The deployment system uses:
88
- **GitHub Actions** to build and push Docker images to GHCR
9-
- **SSH-based deployment** triggered manually via GitHub Actions
9+
- **Automatic deployment** to production on every push to `main`
1010
- **Automatic rollback** if health checks fail
1111

1212
## VPS Directory Structure
@@ -120,15 +120,16 @@ In GitHub repo settings → Environments → Create "production":
120120

121121
## Deployment
122122

123-
### Automatic (after merge to main)
123+
### Automatic (on every push to main)
124124

125125
1. Push/merge to `main` branch
126-
2. GitHub Actions builds and pushes images to GHCR
127-
3. Go to Actions → "Deploy to Production" → Run workflow
128-
4. Enter the image tag (commit SHA) or "latest"
129-
5. If environment protection is enabled, approve the deployment
126+
2. GitHub Actions builds frontend and backend images in parallel
127+
3. Images are pushed to GHCR with commit SHA tag
128+
4. Deploy job SSHs to VPS and runs `deploy.sh` with the commit SHA
129+
5. Health check verifies deployment succeeded
130+
6. Automatic rollback if health check fails
130131

131-
### Manual deployment on VPS
132+
### Manual deployment (for rollbacks or hotfixes)
132133

133134
```bash
134135
# SSH to VPS
@@ -165,9 +166,7 @@ cat /opt/ccsync/deployments/<deployment-dir>/info.txt
165166

166167
## Monitoring
167168

168-
The existing health check script at `/opt/ccsync-monitor/health-check.sh` monitors:
169+
The health check script at `/opt/ccsync-monitor/health-check.sh` monitors:
169170
- Docker container health status
170171
- Backend `/health` endpoint
171172
- Alerts to Zulip on failures
172-
173-
After migration, update the script to use `/opt/ccsync` instead of `~/ccsync`.

0 commit comments

Comments
 (0)