|
33 | 33 | - [Development Tools](#development-tools) |
34 | 34 | - [Type Definitions](#type-definitions) |
35 | 35 | - [Scripts](#scripts) |
| 36 | +- [CI & Deployments](#ci--deployments) |
| 37 | + - [CI Workflows Includes](#ci-workflow-includes) |
| 38 | + - [Vercel Deploy Flow](#-vercel-deploy-flow) |
36 | 39 | - [Grid Overlay Toggle](#grid-overlay-toggle) |
37 | 40 | - [Breakpoints Configuration](#breakpoints-configuration) |
38 | 41 | - [Layout Root (Dynamic SCSS Variables)](#layout-root-dynamic-scss-variables) |
@@ -205,6 +208,33 @@ Core styling configuration files: |
205 | 208 | - `yarn format` - Format code with Prettier |
206 | 209 | - `yarn check-format` - Check code formatting |
207 | 210 |
|
| 211 | +## CI & Deployments |
| 212 | + |
| 213 | +[](https://vercel.com/import/project?template=https://github.com/CFsylvester/next.js-tailwind-typescript-TEMPLATE) |
| 214 | +[](https://github.com/CFsylvester/next.js-tailwind-typescript-TEMPLATE/actions/workflows/ci.yml) |
| 215 | + |
| 216 | +This template includes a built-in GitHub Actions workflow (`ci.yml`) that runs automatically on all pull requests and pushes to `main` and `staging`. |
| 217 | + |
| 218 | +### CI Workflow Includes |
| 219 | + |
| 220 | +- 🔍 Linting with ESLint |
| 221 | +- ✅ Type-checking with TypeScript |
| 222 | +- 🔨 Build verification (`next build`) |
| 223 | +- 🛑 Main branch is protected — requires `[override-main]` in commit message to push directly |
| 224 | + |
| 225 | +> All CI checks must pass before merging into `main` or `staging`. |
| 226 | +> Preview deployments are automatically handled by Vercel for all branches and PRs. |
| 227 | +
|
| 228 | +--- |
| 229 | + |
| 230 | +### 🌐 Vercel Deploy Flow |
| 231 | + |
| 232 | +| Branch | Environment | Deployment | |
| 233 | +| ---------- | ----------- | --------------------------------- | |
| 234 | +| `main` | Production | ✅ Auto-deploy to prod | |
| 235 | +| `staging` | Staging | ✅ Auto-deploy to preview/staging | |
| 236 | +| feature PR | Preview | ✅ Deploy Preview via Vercel | |
| 237 | + |
208 | 238 | ## Grid Overlay Toggle |
209 | 239 |
|
210 | 240 | ### Breakpoints Configuration |
|
0 commit comments