DEPLOY.md.tpl 1023 B

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. # Deploy
  2. Stack: {{STACK}}
  3. Target: {{DEPLOY_TARGET}}<!-- e.g. Vercel, fly.io, Docker on VPS, k8s -->
  4. ## Prerequisites
  5. - {{REQUIRED_TOOLS}}<!-- gh, fly, docker, kubectl, etc. -->
  6. - Environment variables set in {{ENV_LOCATION}}<!-- .env / Vercel dashboard / GH secrets -->
  7. ## Build
  8. ```bash
  9. {{BUILD_CMD}}
  10. ```
  11. Verify the build artifact at `{{BUILD_OUTPUT_DIR}}` is non-empty before proceeding.
  12. ## Deploy
  13. ```bash
  14. {{DEPLOY_CMD}}
  15. ```
  16. ## Verify
  17. ```bash
  18. {{HEALTH_CHECK_CMD}}<!-- curl /healthz or equivalent -->
  19. ```
  20. Expected response: `{{EXPECTED_RESPONSE}}`.
  21. ## Rollback
  22. ```bash
  23. {{ROLLBACK_CMD}}<!-- e.g. fly releases rollback <id>, kubectl rollout undo, vercel rollback -->
  24. ```
  25. ## Common failures
  26. | Symptom | Cause | Fix |
  27. |---|---|---|
  28. | {{SYMPTOM_1}} | {{CAUSE_1}} | {{FIX_1}} |
  29. | Build fails on `{{COMMON_BUILD_ERR}}` | Likely env var missing | Check {{ENV_LOCATION}} has {{REQUIRED_VARS}} |
  30. ## Logs / monitoring
  31. - Logs: `{{LOG_CMD}}`
  32. - Monitoring: {{MONITORING_URL}}<!-- Grafana / Sentry / Vercel analytics -->