Skip to content

Feat/document deployment tradeoffs#110

Merged
AAdewunmi merged 4 commits into
mainfrom
feat/document-deployment-tradeoffs
May 21, 2026
Merged

Feat/document deployment tradeoffs#110
AAdewunmi merged 4 commits into
mainfrom
feat/document-deployment-tradeoffs

Conversation

@AAdewunmi

Copy link
Copy Markdown
Owner

Summary

Documents the Render deployment rationale, platform boundary, and production verification path for the StudyBuddy MVP.

Changes

  • Added a clear “Why Render” rationale to deployment docs.
  • Documented what the app/repo owns versus what Render owns.
  • Clarified out-of-scope platform responsibilities like server provisioning, TLS setup, and load balancer management.
  • Updated release metadata handling so /health/ can report the deployed Render commit.
  • Removed the duplicate /accounts/ auth namespace and kept /users/ as the canonical account route.
  • Updated stale verification counts to the current 202 passed baseline.

Behaviour

The project now has clearer deployment documentation and a cleaner URL surface. Render deployment decisions are explicit, and production health metadata can identify the deployed revision.

Why

This makes the deployment approach easier to review, repeat, and reason about. It also keeps the app boundary focused on Django product behaviour while Render handles platform infrastructure.

Validation

  • Settings tests passed.
  • render.yaml parsed successfully.
  • Focused auth and route tests passed.
  • Markdown/diff checks passed.
  • Confirmed only the regression test references /accounts/.

Result

The repo now documents deployment tradeoffs clearly and removes ambiguity around Render responsibilities, runtime metadata, and auth URL namespaces.

Notes

  • Render live route verification still needs to pass; the documented URL previously returned 404 with x-render-routing: no-server.
  • DJANGO_SECRET_KEY remains Render-injected and is not committed.
  • DATABASE_URL is generated from the managed Render PostgreSQL service.
  • /users/ is now the canonical auth route; /accounts/ intentionally returns 404.

@codecov

codecov Bot commented May 21, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@AAdewunmi AAdewunmi merged commit 5fe564f into main May 21, 2026
2 checks passed
@AAdewunmi AAdewunmi deleted the feat/document-deployment-tradeoffs branch May 21, 2026 13:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

No open projects

Development

Successfully merging this pull request may close these issues.

Document deployment tradeoffs

1 participant