Skip to content

Latest commit

 

History

History
31 lines (25 loc) · 1.34 KB

Deployment.md

File metadata and controls

31 lines (25 loc) · 1.34 KB

EmberDocs Deployment Guide

Goal: deploy EmberDocs with predictable, repeatable steps.

Build & Test Before Deploy

npm run lint
npm run typecheck
npm run test
npm run build
  • Resolve failures locally before shipping.

Environment Configuration

  • Copy .env.example to .env.local for local runs and to your platform’s env settings for deploys.
  • Gate optional services (analytics, semantic search, database) behind env flags; defaults should be safe/off.
  • Never commit secrets; store them in your deployment platform’s secret manager.

Hosting Targets

  • Vercel/Netlify: set NODE_VERSION=18+, install with npm install, build with npm run build.
  • Static export (when supported): run npm run build and serve .next output via your preferred host.
  • Self-host: build once, then npm run start behind a reverse proxy (TLS, caching as needed).

Versioning & Releases

  • Tag releases with vX.Y.Z to align with git-native versioning and doc routing once implemented.
  • Keep dev-docs/planning/ and dev-docs/progress/ updated; link the relevant entries in your release notes/PR.

Post-Deploy Checks

  • Smoke-test navigation, search, and version selector (if enabled).
  • Verify env-flagged integrations behave correctly when missing or disabled.
  • Record deploy outcomes and any incidents in dev-docs/progress/ for the deployment day.