Skip to content

Commit bedad50

Browse files
committed
add readme info
1 parent cc8b2eb commit bedad50

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@
3333
- [Development Tools](#development-tools)
3434
- [Type Definitions](#type-definitions)
3535
- [Scripts](#scripts)
36+
- [CI & Deployments](#ci--deployments)
37+
- [CI Workflows Includes](#ci-workflow-includes)
38+
- [Vercel Deploy Flow](#-vercel-deploy-flow)
3639
- [Grid Overlay Toggle](#grid-overlay-toggle)
3740
- [Breakpoints Configuration](#breakpoints-configuration)
3841
- [Layout Root (Dynamic SCSS Variables)](#layout-root-dynamic-scss-variables)
@@ -205,6 +208,33 @@ Core styling configuration files:
205208
- `yarn format` - Format code with Prettier
206209
- `yarn check-format` - Check code formatting
207210

211+
## CI & Deployments
212+
213+
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/import/project?template=https://github.com/CFsylvester/next.js-tailwind-typescript-TEMPLATE)
214+
[![CI Checks](https://github.com/CFsylvester/next.js-tailwind-typescript-TEMPLATE/actions/workflows/ci.yml/badge.svg)](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+
208238
## Grid Overlay Toggle
209239

210240
### Breakpoints Configuration

0 commit comments

Comments
 (0)