Skip to content

CICD-Quick-Reference.md

Latest commit

 

History

History
executable file
·
160 lines (129 loc) · 3.4 KB

CICD-Quick-Reference.md

File metadata and controls

executable file
·
160 lines (129 loc) · 3.4 KB

ChittyOS CI/CD Quick Reference Card

🚀 Common Commands

Initial Setup

# One-time setup for all repos
./setup-org-workflows.sh

# Manual setup for single repo
gh workflow run setup.yml

Daily Operations

# Check workflow status
gh run list --limit 10

# View failed runs
gh run list --status=failure

# Rerun failed workflow
gh run rerun --failed [RUN_ID]

# View workflow logs
gh run view --log [RUN_ID]

Deployment Commands

# Manual deployment trigger
gh workflow run deploy.yml --ref main

# Vercel deployment
vercel --prod

# Cloudflare deployment
npx wrangler publish

🔐 Required Secrets

GitHub Repository Secrets

Secret Used For Required
BEACON_ENDPOINT ChittyBeacon URL Optional
CLOUDFLARE_API_TOKEN CF deployments If using CF
CLOUDFLARE_ACCOUNT_ID CF account If using CF
VERCEL_TOKEN Vercel deploys If using Vercel
VERCEL_ORG_ID Vercel org If using Vercel
VERCEL_PROJECT_ID Vercel project If using Vercel
SNYK_TOKEN Security scans Recommended

📦 ChittyBeacon Integration

Node.js

npm install @chittycorp/app-beacon --save
// Add to top of entry file
require('@chittycorp/app-beacon');

Python

# Add to top of entry file
import chittybeacon

Environment Variables

BEACON_ENDPOINT=https://beacon.cloudeto.com  # Optional
BEACON_INTERVAL=300000  # 5 minutes
BEACON_DISABLED=false   # Enable/disable
BEACON_VERBOSE=false    # Debug mode

🚨 Troubleshooting

Workflow Not Running?

  1. Check file location: .github/workflows/*.yml
  2. Verify YAML syntax
  3. Check repository Actions settings
  4. Review workflow triggers

Authentication Failed?

  1. Check secret exists: gh secret list
  2. Regenerate token if expired
  3. Verify token permissions
  4. Update secret: gh secret set TOKEN_NAME

Deployment Failed?

  1. Check deployment logs
  2. Verify all secrets are set
  3. Test locally first
  4. Check service quotas

ChittyBeacon Not Working?

  1. Verify import is at top of entry file
  2. Check network connectivity
  3. Enable verbose mode: BEACON_VERBOSE=true
  4. Check dashboard: https://beacon.cloudeto.com

📊 Monitoring Links

🆘 Emergency Contacts

  • DevOps On-call: #devops-oncall (Slack)
  • Security Issues: security@chittyos.com
  • CI/CD Support: #ci-cd-help (Slack)

📋 Workflow Templates

Basic CI Workflow

name: CI
on: [push, pull_request]
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
      - run: npm ci
      - run: npm test

Deploy on Main

name: Deploy
on:
  push:
    branches: [main]
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - run: npm ci
      - run: npm run build
      - run: npm run deploy

✅ Pre-deployment Checklist

  • All tests passing
  • ChittyBeacon integrated
  • Secrets configured
  • Branch protection enabled
  • Security scans clean
  • Documentation updated

Version: 1.0 | Updated: 2025-08-06 | Full SOPs: ChittyOS-CICD-SOPs.md