CI/CD Pipeline

Overview

Pulse Content uses GitHub Actions for continuous integration and deployment:

✅ Automated testing on every push and pull request
🚀 Automatic deployment to Cloudflare Pages on main branch
🔍 Type checking to catch errors before deployment
📦 Dependency caching for faster builds

Workflow Configuration

File Location

.github/workflows/deploy.yml

Workflow Structure

name: Deploy to Cloudflare Pages

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  test:
    name: Test
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: '20'
          cache: 'npm'

      - name: Install dependencies
        run: npm ci

      - name: Run tests
        run: npm run test:run

      - name: Type check
        run: npm run typecheck

  deploy:
    name: Deploy
    runs-on: ubuntu-latest
    needs: test
    if: github.ref == 'refs/heads/main'
    permissions:
      contents: read
      deployments: write
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: '20'
          cache: 'npm'

      - name: Install dependencies
        run: npm ci

      - name: Build
        run: npm run build

      - name: Deploy to Cloudflare Pages
        uses: cloudflare/wrangler-action@v3
        with:
          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
          command: pages deploy dist --project-name=pulse-content

Pipeline Stages

Stage 1: Test Job

Checkout code

Clones repository to GitHub Actions runner

- uses: actions/checkout@v4

Setup Node.js

Installs Node.js 20 with npm caching

- uses: actions/setup-node@v4
  with:
    node-version: '20'
    cache: 'npm'

Install dependencies

Uses npm ci for clean, reproducible installs

npm ci  # Faster than npm install, uses package-lock.json

Run tests

Executes Vitest test suite

npm run test:run  # Runs tests once, exits with code

Test failures block deployment. Fix all tests before merging.

Type check

Validates TypeScript types without emitting files

npm run typecheck  # tsc --noEmit

Stage 2: Deploy Job

Conditional execution: Only runs if:

Test job passes
Push is to main branch

Checkout code

Clones repository again (jobs run in isolation)

Setup Node.js

Installs Node.js 20 with npm caching

Install dependencies

npm ci

Build for production

Compiles TypeScript and bundles with Vite

npm run build
# Output: dist/ directory

Deploy to Cloudflare Pages

Uses official Cloudflare Wrangler action

- uses: cloudflare/wrangler-action@v3
  with:
    apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
    accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
    command: pages deploy dist --project-name=pulse-content

Deployment URL is output in GitHub Actions logs

GitHub Secrets

Required Secrets

Add these in GitHub repository settings: Location: Settings > Secrets and variables > Actions > New repository secret

CLOUDFLARE_API_TOKEN

string

required

Cloudflare API token with Cloudflare Pages:Edit permissionsGenerate:

Go to dash.cloudflare.com/profile/api-tokens
Click Create Token
Use Edit Cloudflare Workers template
Add Cloudflare Pages:Edit permission
Copy token (only shown once)

CLOUDFLARE_ACCOUNT_ID

string

required

Your Cloudflare account IDFind:

Go to dash.cloudflare.com
Copy Account ID from sidebar

Optional Secrets

For additional features:

SLACK_WEBHOOK_URL       # Deployment notifications
DISCORD_WEBHOOK_URL     # Deployment notifications
SENTRY_AUTH_TOKEN       # Error tracking integration

Workflow Triggers

On Push to Main

Automatic deployment:

on:
  push:
    branches:
      - main

Workflow:

Developer merges PR to main
GitHub Actions runs test job
If tests pass, deploy job runs
Code deploys to production

On Pull Request

Tests only (no deployment):

on:
  pull_request:
    branches:
      - main

Workflow:

Developer opens PR
GitHub Actions runs test job
PR shows test status ✅ or ❌
No deployment occurs

Manual Trigger (Optional)

Add workflow_dispatch for manual runs:

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main
  workflow_dispatch:  # Enable manual trigger

Usage: Actions tab > Deploy to Cloudflare Pages > Run workflow

Build Artifacts

Caching Strategy

Node modules cache:

- uses: actions/setup-node@v4
  with:
    cache: 'npm'  # Caches ~/.npm directory

Benefits:

50-70% faster dependency installation
Reduced GitHub Actions minutes usage

Build Output

Directory: dist/ Contents:

Compiled JavaScript bundles
Optimized CSS
Static assets (fonts, images)
Source maps

Size: ~2-3 MB (uncompressed)

Deployment Previews

Cloudflare Pages automatically creates preview deployments:

For Pull Requests

Unique URL per PR
Automatic updates on new commits
No production impact

Example: https://a1b2c3d4.pulse-content.pages.dev

Preview Comments

Cloudflare bot comments on PR with preview URL:

✅ Deploy Preview ready!
🔗 https://a1b2c3d4.pulse-content.pages.dev

View the full deployment details: https://dash.cloudflare.com/...

Monitoring Deployments

GitHub Actions UI

View workflow runs:

Go to repository Actions tab
See all workflow runs with status
Click run for detailed logs

Status badges:

✅ Success (tests passed, deployed)
❌ Failure (tests failed, not deployed)
🟡 In Progress

Cloudflare Dashboard

View deployments:

Go to dash.cloudflare.com
Navigate to Workers & Pages > pulse-content
See deployment history, logs, analytics

Troubleshooting

Tests fail in CI but pass locally

Common causes:

Environment variables missing
Different Node.js versions
Race conditions in async tests

Fix:

# Match CI Node version
nvm use 20

# Run tests in CI mode locally
npm run test:run

Deployment fails with authentication error

Verify:

CLOUDFLARE_API_TOKEN is set correctly
Token has Cloudflare Pages:Edit permission
Token hasn’t expired

Regenerate token:

Create new token in Cloudflare
Update GitHub secret
Re-run workflow

Build succeeds but deployment fails

Check:

dist/ directory exists and contains files
wrangler.toml configuration is correct
Project name matches: pulse-content

Debug:

# Test build locally
npm run build
ls -la dist/

# Test deployment locally
npm run deploy

Workflow runs but doesn't deploy

Verify conditions:

Push is to main branch (not develop or other)
Test job passed successfully
needs: test dependency is correct

Check workflow file:

if: github.ref == 'refs/heads/main'

Performance Optimization

Parallel Jobs

Run independent jobs in parallel:

jobs:
  test:
    # ...
  lint:
    runs-on: ubuntu-latest
    steps:
      - run: npm run lint
  typecheck:
    runs-on: ubuntu-latest
    steps:
      - run: npm run typecheck

Matrix Testing

Test across multiple Node versions:

jobs:
  test:
    strategy:
      matrix:
        node-version: [18, 20, 22]
    steps:
      - uses: actions/setup-node@v4
        with:
          node-version: ${{ matrix.node-version }}

Next Steps

Cloudflare Deployment

Manual deployment guide

Environment Config

Manage environment variables

Testing Strategy

Learn about testing

Contributing

Contribution guidelines

Getting Started

Deployment

Contributing

Overview

Workflow Configuration

File Location

Workflow Structure

Pipeline Stages

Stage 1: Test Job

Stage 2: Deploy Job

GitHub Secrets

Required Secrets

Optional Secrets

Workflow Triggers

On Push to Main

On Pull Request

Manual Trigger (Optional)

Build Artifacts

Caching Strategy

Build Output

Deployment Previews

For Pull Requests

Preview Comments

Monitoring Deployments

GitHub Actions UI

Cloudflare Dashboard

Troubleshooting

Performance Optimization

Parallel Jobs

Matrix Testing

Next Steps

Cloudflare Deployment

Environment Config

Testing Strategy

Contributing

Build docs developers (and LLMs) love

Getting Started

Deployment

Contributing

​Overview

​Workflow Configuration

​File Location

​Workflow Structure

​Pipeline Stages

​Stage 1: Test Job

​Stage 2: Deploy Job

​GitHub Secrets

​Required Secrets

​Optional Secrets

​Workflow Triggers

​On Push to Main

​On Pull Request

​Manual Trigger (Optional)

​Build Artifacts

​Caching Strategy

​Build Output

​Deployment Previews

​For Pull Requests

​Preview Comments

​Monitoring Deployments

​GitHub Actions UI

​Cloudflare Dashboard

​Troubleshooting

​Performance Optimization

​Parallel Jobs

​Matrix Testing

​Next Steps

Cloudflare Deployment

Environment Config

Testing Strategy

Contributing

Build docs developers (and LLMs) love

Overview

Workflow Configuration

File Location

Workflow Structure

Pipeline Stages

Stage 1: Test Job

Stage 2: Deploy Job

GitHub Secrets

Required Secrets

Optional Secrets

Workflow Triggers

On Push to Main

On Pull Request

Manual Trigger (Optional)

Build Artifacts

Caching Strategy

Build Output

Deployment Previews

For Pull Requests

Preview Comments

Monitoring Deployments

GitHub Actions UI

Cloudflare Dashboard

Troubleshooting

Performance Optimization

Parallel Jobs

Matrix Testing

Next Steps