| name | ci-cd-pipeline |
| description | Use this skill for CI/CD pipeline design during framework planning. Provides templates for GitHub Actions, GitLab CI, and deployment strategies. |
| metadata | {"author":"Ankurjain1121"} |
Deployment Pipeline Design
This skill guides CI/CD pipeline design during framework planning, providing templates and best practices for automated build, test, and deployment workflows.
Pipeline Stages Overview
┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐
│ Build │──▶│ Test │──▶│ Scan │──▶│ Stage │──▶│ Prod │
└─────────┘ └─────────┘ └─────────┘ └─────────┘ └─────────┘
│ │ │ │ │
▼ ▼ ▼ ▼ ▼
Compile Unit Tests Security Deploy to Deploy to
Lint Integration SAST/DAST Staging Production
Type Check E2E Tests Deps Audit Smoke Test Health Check
GitHub Actions Template
Basic Node.js Pipeline
name: CI/CD Pipeline
on:
push:
branches: [main, develop]
pull_request:
branches: [main]
env:
NODE_VERSION: '20'
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: ${{ env.NODE_VERSION }}
cache: 'npm'
- name: Install dependencies
run: npm ci
- name: Lint
run: npm run lint
- name: Type check
run: npm run type-check
- name: Build
run: npm run build
- name: Upload build artifacts
uses: actions/upload-artifact@v4
with:
name: build
path: dist/
test:
needs: build
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: ${{ env.NODE_VERSION }}
cache: 'npm'
- name: Install dependencies
run: npm ci
- name: Run unit tests
run: npm run test:unit -- --coverage
- name: Run integration tests
run: npm run test:integration
- name: Upload coverage
uses: codecov/codecov-action@v4
with:
files: ./coverage/lcov.info
security:
needs: build
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Run security audit
run: npm audit --audit-level=high
- name: Run SAST
uses: github/codeql-action/analyze@v3
deploy-staging:
needs: [test, security]
if: github.ref == 'refs/heads/develop'
runs-on: ubuntu-latest
environment: staging
steps:
- uses: actions/checkout@v4
- name: Download build
uses: actions/download-artifact@v4
with:
name: build
path: dist/
- name: Deploy to staging
run: |
# Your deployment command here
echo "Deploying to staging..."
- name: Smoke tests
run: npm run test:smoke -- --env=staging
deploy-production:
needs: [test, security]
if: github.ref == 'refs/heads/main'
runs-on: ubuntu-latest
environment: production
steps:
- uses: actions/checkout@v4
- name: Download build
uses: actions/download-artifact@v4
with:
name: build
path: dist/
- name: Deploy to production
run: |
# Your deployment command here
echo "Deploying to production..."
- name: Health check
run: curl -f ${{ vars.PROD_URL }}/health || exit 1
GitLab CI Template
stages:
- build
- test
- security
- staging
- production
variables:
NODE_VERSION: "20"
default:
image: node:${NODE_VERSION}
cache:
paths:
- node_modules/
build:
stage: build
script:
- npm ci
- npm run lint
- npm run type-check
- npm run build
artifacts:
paths:
- dist/
expire_in: 1 hour
test:unit:
stage: test
script:
- npm ci
- npm run test:unit
Environment Strategy
Environment Progression
Feature Branch → develop → staging → main → production
│ │ │ │ │
▼ ▼ ▼ ▼ ▼
PR Tests Integration QA Test Final Live
Tests Manual Review
Environment Configuration
| Environment | Purpose | Data | Access |
|---|
| Development | Local dev | Fake/seed | Developer |
| CI | Automated tests | Test fixtures | CI only |
| Staging | Pre-production | Anonymized prod | Team |
| Production | Live | Real | Restricted |
Deployment Strategies
Blue-Green Deployment
┌─────────────┐
│ Load │
│ Balancer │
└──────┬──────┘
│
┌───────┴───────┐
│ │
┌──────▼──────┐ ┌──────▼──────┐
│ Blue │ │ Green │
│ (v1.0) │ │ (v1.1) │
│ [ACTIVE] │ │ [STANDBY] │
└─────────────┘ └─────────────┘
1. Deploy to Green (standby)
2. Test Green
3. Switch traffic to Green
4. Blue becomes standby
Canary Deployment
┌─────────────┐
│ Load │
│ Balancer │
└──────┬──────┘
│
┌──────────┼──────────┐
│ │ │
▼ (90%) ▼ (10%) │
┌───────────┐ ┌───────────┐
│ Stable │ │ Canary │
│ (v1.0) │ │ (v1.1) │
└───────────┘ └───────────┘
1. Deploy canary with 10% traffic
2. Monitor metrics
3. Gradually increase to 100%
4. Rollback if issues
Rolling Deployment
Time 0: [v1] [v1] [v1] [v1]
Time 1: [v2] [v1] [v1] [v1]
Time 2: [v2] [v2] [v1] [v1]
Time 3: [v2] [v2] [v2] [v1]
Time 4: [v2] [v2] [v2] [v2]
Secrets Management
GitHub Secrets
env:
DATABASE_URL: ${{ secrets.DATABASE_URL }}
API_KEY: ${{ secrets.API_KEY }}
- name: Deploy
env:
TOKEN: ${{ secrets.DEPLOY_TOKEN }}
run: deploy.sh
Required Secrets
| Secret | Environment | Purpose |
|---|
DATABASE_URL | staging, production | Database connection |
JWT_SECRET | staging, production | Token signing |
DEPLOY_TOKEN | CI | Deployment auth |
CODECOV_TOKEN | CI | Coverage reporting |
Pipeline Checklist
Before deploying:
Integration with Framework Developer
During Phase 3 (Planning) or Phase 6 (Integration):
- Choose CI/CD platform
- Define environment strategy
- Create pipeline configuration
- Set up secrets management
- Configure deployment targets
- Document in final report
Source: Ankurjain1121/framework-developer-agent — distributed by TomeVault.
