mirror of
https://github.com/hanzoai/skills.git
synced 2026-11-19 00:47:36 +00:00
hanzoskills.com/llms.txt now opens with the install line, the API reference index and the company index, so an agent that lands on any one of the three can find the rest. robots.txt claimed 537 documents while llms.txt counts 920. The number is gone from robots.txt; llms.txt derives it. public/ is regenerated from scripts/site.py, which it had fallen behind: the copy-prompt menu and agent bar were in the generator and not in the committed pages. tests/site.mjs passes against the result. Co-authored-by: Hanzo Dev <[email protected]>
658 lines
26 KiB
HTML
658 lines
26 KiB
HTML
<!doctype html>
|
|
<html lang="en"><head>
|
|
<meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1">
|
|
<title>engineering-continuous-integration</title>
|
|
<meta name="color-scheme" content="dark">
|
|
<style>
|
|
/* Committed to one visual world: a dark instrument panel. No light variant —
|
|
the dot field and the hairline rules only read on black, and a naive
|
|
inversion would wash both out. Every colour is painted explicitly so the page
|
|
never borrows a host background. */
|
|
@font-face{font-family:'Zen';src:url('/fonts/Zen-Variable.woff2') format('woff2');font-weight:100 900;font-style:normal;font-display:swap}
|
|
@font-face{font-family:'Zen';src:url('/fonts/Zen-Italic-Variable.woff2') format('woff2');font-weight:100 900;font-style:italic;font-display:swap}
|
|
@font-face{font-family:'Zen Mono';src:url('/fonts/ZenMono-Variable.woff2') format('woff2');font-weight:100 900;font-style:normal;font-display:swap}
|
|
@font-face{font-family:'Zen Mono';src:url('/fonts/ZenMono-Italic-Variable.woff2') format('woff2');font-weight:100 900;font-style:italic;font-display:swap}
|
|
@font-face{font-family:'Zen Pixel Square';src:url('/fonts/ZenPixel-Square.woff2') format('woff2');font-style:normal;font-display:swap}
|
|
|
|
:root{
|
|
--ink:#f4f4f2; --soft:#9c9c98; --faint:#6a6a66; --ground:#000; --panel:#0a0a0a;
|
|
--line:#232323; --line-hi:#3a3a3a; --accent:#f4f4f2;
|
|
--font-zen-sans:'Zen',-apple-system,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif;
|
|
--font-zen-mono:'Zen Mono',ui-monospace,"SF Mono",SFMono-Regular,Menlo,Consolas,monospace;
|
|
--font-zen-pixel-square:'Zen Pixel Square',monospace;
|
|
--mono:var(--font-zen-mono);
|
|
--sans:var(--font-zen-sans);
|
|
/* Controls are pills and surfaces are soft, as on hanzo.ai. */
|
|
--r:999px; --r-soft:14px;
|
|
}
|
|
*{box-sizing:border-box}
|
|
html{-webkit-text-size-adjust:100%}
|
|
body{margin:0;background:var(--ground);color:var(--ink);font-family:var(--sans);
|
|
font-size:16px;line-height:1.65;-webkit-font-smoothing:antialiased}
|
|
.wrap{max-width:60rem;margin:0 auto;padding:0 1.75rem}
|
|
|
|
/* The dot field. A halftone made of one repeating radial-gradient, faded out
|
|
along the diagonal by a mask so it reads as a wave rather than wallpaper. */
|
|
/* No overflow clip here: the dot field is inset to the box already, and a clip
|
|
would cut off the copy-prompt menu. */
|
|
.hero{position:relative;border-bottom:1px solid var(--line)}
|
|
.hero::before{content:"";position:absolute;inset:0;
|
|
background-image:radial-gradient(var(--line-hi) 1px, transparent 1px);
|
|
background-size:7px 7px;
|
|
-webkit-mask-image:linear-gradient(115deg,#000 0%,rgba(0,0,0,.55) 38%,transparent 72%);
|
|
mask-image:linear-gradient(115deg,#000 0%,rgba(0,0,0,.55) 38%,transparent 72%);
|
|
pointer-events:none}
|
|
.hero .wrap{position:relative;padding-top:5.5rem;padding-bottom:4rem}
|
|
|
|
nav{border-bottom:1px solid var(--line)}
|
|
nav .in{max-width:60rem;margin:0 auto;padding:1.1rem 1.75rem;display:flex;
|
|
justify-content:space-between;align-items:center;gap:1rem}
|
|
.brand{font-family:var(--mono);font-size:.85rem;letter-spacing:.14em;
|
|
text-transform:uppercase;color:var(--ink);text-decoration:none;
|
|
display:inline-flex;align-items:center;gap:.6rem}
|
|
.brand i{font-style:normal;color:var(--faint)}
|
|
.mark{width:1.15em;height:1.15em;display:block;flex:0 0 auto}
|
|
nav a.up{font-family:var(--mono);font-size:.72rem;letter-spacing:.14em;
|
|
text-transform:uppercase;color:var(--soft);text-decoration:none}
|
|
nav a.up:hover{color:var(--ink)}
|
|
|
|
h1{font-family:var(--mono);font-size:clamp(2rem,5.4vw,3.4rem);line-height:1.12;
|
|
letter-spacing:-.02em;margin:0 0 1.1rem;font-weight:500;text-wrap:balance}
|
|
h1 em{font-style:normal;color:var(--faint)}
|
|
.lede{color:var(--soft);font-size:1.05rem;max-width:52ch;margin:0 0 2.25rem}
|
|
|
|
.btns{display:flex;flex-wrap:wrap;gap:.7rem;margin:0 0 .5rem;align-items:center}
|
|
.btn{display:inline-flex;align-items:center;gap:.5rem;font-family:var(--mono);
|
|
font-size:.72rem;letter-spacing:.14em;text-transform:uppercase;
|
|
padding:.8rem 1.4rem;border:1px solid var(--line-hi);border-radius:var(--r);
|
|
color:var(--ink);text-decoration:none;background:transparent;cursor:pointer;
|
|
line-height:1.2;font-weight:400}
|
|
.btn:hover{background:#141414;text-decoration:none;border-color:var(--soft)}
|
|
.btn.solid{background:var(--ink);color:#000;border-color:var(--ink)}
|
|
.btn.solid:hover{background:#d8d8d4}
|
|
.btn .chev{width:.7em;height:.7em;flex:0 0 auto;transition:transform .15s ease}
|
|
.btn[aria-expanded="true"] .chev{transform:rotate(180deg)}
|
|
|
|
/* Copy-prompt selector. Each row copies the prompt for its own target. */
|
|
.copy{position:relative;display:inline-flex}
|
|
.menu{position:absolute;top:calc(100% + .5rem);left:0;z-index:20;min-width:21rem;
|
|
background:var(--panel);border:1px solid var(--line-hi);border-radius:var(--r-soft);
|
|
padding:.4rem;display:flex;flex-direction:column;
|
|
box-shadow:0 12px 32px rgba(0,0,0,.75)}
|
|
.menu[hidden]{display:none}
|
|
.mi{display:flex;align-items:center;gap:.7rem;width:100%;text-align:left;
|
|
padding:.62rem .8rem;border:0;border-radius:calc(var(--r-soft) - .35rem);
|
|
background:transparent;color:var(--ink);font-family:var(--mono);font-size:.76rem;
|
|
letter-spacing:.04em;text-decoration:none;cursor:pointer;line-height:1.3;
|
|
white-space:nowrap}
|
|
.mi:hover,.mi:focus-visible{background:#181818;outline:none}
|
|
.mi .mark{width:1.05rem;height:1.05rem;color:var(--soft)}
|
|
.mi:hover .mark{color:var(--ink)}
|
|
.mi u{margin-left:auto;color:var(--faint);text-decoration:none;font-size:.68rem;
|
|
letter-spacing:.1em;text-transform:uppercase}
|
|
|
|
/* Works-with bar: one scrolling row, name and mark per agent. */
|
|
.strip{border-bottom:1px solid var(--line);background:var(--panel)}
|
|
.strip .in{max-width:60rem;margin:0 auto;padding:.9rem 1.75rem;display:flex;
|
|
align-items:center;gap:1.25rem;font-family:var(--mono);font-size:.72rem;
|
|
letter-spacing:.1em;text-transform:uppercase;color:var(--faint)}
|
|
.strip b{color:var(--soft);font-weight:400;flex:0 0 auto;
|
|
border-right:1px solid var(--line);padding-right:1.25rem;align-self:stretch;
|
|
display:flex;align-items:center}
|
|
.bar{display:flex;align-items:center;gap:.5rem;flex:1 1 auto;min-width:0;
|
|
overflow-x:auto;scrollbar-width:none;scroll-snap-type:x proximity;
|
|
-webkit-overflow-scrolling:touch;
|
|
-webkit-mask-image:linear-gradient(90deg,#000 calc(100% - 3rem),transparent);
|
|
mask-image:linear-gradient(90deg,#000 calc(100% - 3rem),transparent)}
|
|
.bar::-webkit-scrollbar{display:none}
|
|
.agent{display:inline-flex;align-items:center;gap:.45rem;flex:0 0 auto;
|
|
padding:.4rem .85rem;border:1px solid var(--line);border-radius:var(--r);
|
|
color:var(--soft);white-space:nowrap;scroll-snap-align:start;
|
|
text-decoration:none;background:var(--ground)}
|
|
.agent:hover{color:var(--ink);border-color:var(--line-hi);text-decoration:none}
|
|
.agent .mark{width:.95rem;height:.95rem}
|
|
|
|
h2{font-family:var(--mono);font-size:1.1rem;letter-spacing:-.01em;margin:2.75rem 0 .75rem;font-weight:500}
|
|
h3{font-size:1rem;margin:2rem 0 .5rem;font-weight:600}
|
|
h4,h5,h6{font-size:.94rem;margin:1.5rem 0 .5rem;font-weight:600}
|
|
p{margin:0 0 1rem;max-width:70ch}
|
|
ul,ol{margin:0 0 1rem;padding-left:1.35rem;max-width:70ch}
|
|
li{margin:.22rem 0}
|
|
a{color:var(--ink);text-decoration:underline;text-underline-offset:3px;
|
|
text-decoration-color:var(--line-hi)}
|
|
a:hover{text-decoration-color:var(--ink)}
|
|
a:focus-visible{outline:1px solid var(--ink);outline-offset:3px}
|
|
code{font-family:var(--mono);font-size:.85em;background:var(--panel);
|
|
border:1px solid var(--line);border-radius:5px;padding:.1em .36em}
|
|
pre{background:var(--panel);border:1px solid var(--line);padding:1rem 1.1rem;
|
|
border-radius:var(--r-soft);overflow-x:auto;margin:0 0 1.25rem}
|
|
pre code{background:none;border:0;padding:0;font-size:.82rem;line-height:1.7}
|
|
blockquote{margin:0 0 1rem;padding-left:1rem;border-left:1px solid var(--line-hi);color:var(--soft)}
|
|
hr{border:0;border-top:1px solid var(--line);margin:2.5rem 0}
|
|
table{border-collapse:collapse;width:100%;margin:0 0 1.25rem;font-size:.92rem;
|
|
display:block;overflow-x:auto}
|
|
th,td{border:1px solid var(--line);padding:.5rem .7rem;text-align:left}
|
|
|
|
.curl{display:block;background:var(--panel);border:1px solid var(--line);
|
|
border-radius:var(--r-soft);padding:.95rem 1.1rem;font-family:var(--mono);
|
|
font-size:.8rem;color:var(--soft);overflow-x:auto;margin:0 0 2.5rem;
|
|
white-space:pre;line-height:1.9}
|
|
.curl b{color:var(--ink);font-weight:400}
|
|
.curl i{font-style:normal;color:var(--faint)}
|
|
|
|
/* index */
|
|
#q{width:100%;padding:.85rem 1.2rem;font-family:var(--mono);font-size:.85rem;color:var(--ink);
|
|
background:var(--panel);border:1px solid var(--line);border-radius:var(--r);margin:0 0 .6rem}
|
|
#q::placeholder{color:var(--faint);text-transform:uppercase;letter-spacing:.1em;font-size:.72rem}
|
|
#q:focus{outline:none;border-color:var(--soft)}
|
|
#count{color:var(--faint);font-family:var(--mono);font-size:.72rem;letter-spacing:.1em;
|
|
text-transform:uppercase;margin:0 0 2rem}
|
|
.cat{margin:2.5rem 0 .5rem;font-family:var(--mono);font-size:.7rem;letter-spacing:.16em;
|
|
text-transform:uppercase;color:var(--faint);border-bottom:1px solid var(--line);
|
|
padding-bottom:.45rem}
|
|
.row{display:block;padding:.6rem .9rem;margin:0 -.9rem;border-bottom:1px solid var(--line);
|
|
border-radius:var(--r-soft);text-decoration:none}
|
|
.row:hover{background:#0a0a0a}
|
|
.nm{font-family:var(--mono);font-size:.84rem;color:var(--ink);display:block}
|
|
.ds{color:var(--soft);font-size:.9rem;display:block;margin-top:.12rem}
|
|
footer{margin-top:4rem;padding:2rem 0 4rem;border-top:1px solid var(--line);
|
|
color:var(--faint);font-size:.85rem}
|
|
footer a{color:var(--soft)}
|
|
.fmap{display:grid;gap:1.75rem;grid-template-columns:repeat(auto-fit,minmax(11rem,1fr));
|
|
margin:0 0 2rem;font-size:.85rem}
|
|
.fmap b{display:block;font-family:var(--mono);font-size:.68rem;letter-spacing:.16em;
|
|
text-transform:uppercase;color:var(--faint);font-weight:400;margin:0 0 .6rem;
|
|
border-bottom:1px solid var(--line);padding-bottom:.4rem}
|
|
.fmap a{display:inline-block;color:var(--ink);text-decoration:none;margin:.3rem .35rem 0 0}
|
|
.fmap a:hover{text-decoration:underline}
|
|
.fmap div{color:var(--faint);line-height:1.5}
|
|
.fend{border-top:1px solid var(--line);padding-top:1.25rem;font-size:.82rem}
|
|
|
|
@media (max-width:640px){
|
|
.hero .wrap{padding-top:3.25rem;padding-bottom:2.75rem}
|
|
.btns{gap:.5rem}
|
|
.btn{padding:.75rem 1.15rem;font-size:.68rem}
|
|
.copy,.copy .btn{width:100%;justify-content:center}
|
|
.menu{left:0;right:0;min-width:0}
|
|
.strip .in{flex-direction:column;align-items:flex-start;gap:.6rem;padding:.9rem 1.75rem}
|
|
.strip b{border-right:0;padding-right:0}
|
|
.bar{width:100%}
|
|
}
|
|
</style>
|
|
<link rel="alternate" type="text/markdown" href="/engineering-continuous-integration.md">
|
|
|
|
<link rel="icon" href="/favicon.svg">
|
|
<link rel="canonical" href="https://hanzoskills.com/engineering-continuous-integration">
|
|
</head>
|
|
<!-- Reading this with a machine? Every page here is also plain markdown.
|
|
This one: https://hanzoskills.com/engineering-continuous-integration.md
|
|
Index: https://hanzoskills.com/llms.txt
|
|
Corpus: https://hanzoskills.com/all.md
|
|
Append .md to any path for the markdown twin. -->
|
|
<body>
|
|
<nav><div class="in">
|
|
<a class="brand" href="/"><svg class="mark" viewBox="0 0 67 67" fill="currentColor" aria-hidden="true"><path d="M22.21 67V44.6369H0V67H22.21Z"/><path d="M66.7038 22.3184H22.2534L0.0878906 44.6367H44.4634L66.7038 22.3184Z"/><path d="M22.21 0H0V22.3184H22.21V0Z"/><path d="M66.7198 0H44.5098V22.3184H66.7198V0Z"/><path d="M66.7198 67V44.6369H44.5098V67H66.7198Z"/></svg> HANZO<i>SKILLS</i></a>
|
|
<a class="up" href="/">All skills</a>
|
|
</div></nav>
|
|
|
|
<div class="wrap">
|
|
<h1>engineering-continuous-integration</h1><p class="lede">CI/CD pipeline design, automated testing, deployment strategies, and continuous delivery best practices</p><h1>Continuous Integration & Delivery</h1>
|
|
<p><strong>Scope</strong>: Comprehensive guide to CI/CD pipelines, automated testing, deployment strategies, and delivery practices <strong>Lines</strong>: ~350 <strong>Last Updated</strong>: 2025-10-27 <strong>Format Version</strong>: 1.0 (Atomic)</p>
|
|
<hr>
|
|
<h2>When to Use This Skill</h2>
|
|
<p>Activate this skill when:</p>
|
|
<ul><li>Setting up CI/CD for a project</li><li>Automating build and test processes</li><li>Implementing deployment pipelines</li><li>Establishing quality gates</li><li>Reducing manual deployment work</li><li>Improving deployment confidence</li><li>Shortening feedback loops</li><li>Scaling engineering team</li></ul>
|
|
<h2>Core Concepts</h2>
|
|
<h3>Concept 1: Continuous Integration (CI)</h3>
|
|
<p><strong>Definition</strong>: Automatically build and test code on every commit</p>
|
|
<p><strong>Key Principles</strong>:</p>
|
|
<ol><li>Commit code frequently (multiple times per day)</li><li>Every commit triggers automated build</li><li>Automated tests run on every build</li><li>Fix broken builds immediately</li><li>Keep build fast (< 10 minutes)</li></ol>
|
|
<p><strong>Benefits</strong>:</p>
|
|
<ul><li>Catch bugs early</li><li>Reduce integration problems</li><li>Deploy faster</li><li>Increase confidence</li></ul>
|
|
<hr>
|
|
<h3>Concept 2: Continuous Delivery (CD)</h3>
|
|
<p><strong>Definition</strong>: Every change can be deployed to production automatically</p>
|
|
<pre><code>Continuous Integration
|
|
↓
|
|
Continuous Delivery (can deploy any time)
|
|
↓
|
|
Continuous Deployment (auto-deploy to production)</code></pre>
|
|
<p><strong>Deployment Strategies</strong>:</p>
|
|
<ul><li><strong>Blue-Green</strong>: Two environments, switch traffic</li><li><strong>Canary</strong>: Gradual rollout to subset of users</li><li><strong>Rolling</strong>: Update instances one at a time</li><li><strong>Feature Flags</strong>: Deploy code, enable features later</li></ul>
|
|
<hr>
|
|
<h3>Concept 3: Pipeline Stages</h3>
|
|
<p><strong>Typical CI/CD Pipeline</strong>:</p>
|
|
<pre><code>Commit → Build → Test → Deploy → Monitor
|
|
↓ ↓ ↓ ↓ ↓
|
|
Code Compile Unit Staging Metrics
|
|
Package Lint Prod Alerts
|
|
E2E</code></pre>
|
|
<hr>
|
|
<h2>Patterns</h2>
|
|
<h3>Pattern 1: GitHub Actions Pipeline</h3>
|
|
<p><strong>Basic CI Pipeline</strong>:</p>
|
|
<pre><code class="lang-yaml"># .github/workflows/ci.yml
|
|
name: CI Pipeline
|
|
|
|
on:
|
|
push:
|
|
branches: [main, develop]
|
|
pull_request:
|
|
branches: [main]
|
|
|
|
jobs:
|
|
test:
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
|
|
- name: Set up Python
|
|
uses: actions/setup-python@v4
|
|
with:
|
|
python-version: '3.11'
|
|
|
|
- name: Install dependencies
|
|
run: |
|
|
python -m pip install --upgrade pip
|
|
pip install -r requirements.txt
|
|
|
|
- name: Lint with flake8
|
|
run: |
|
|
flake8 src/ --max-complexity=10
|
|
|
|
- name: Type check with mypy
|
|
run: |
|
|
mypy src/
|
|
|
|
- name: Run tests
|
|
run: |
|
|
pytest tests/ --cov=src --cov-fail-under=80
|
|
|
|
- name: Upload coverage
|
|
uses: codecov/codecov-action@v3</code></pre>
|
|
<hr>
|
|
<h3>Pattern 2: Multi-Stage Pipeline</h3>
|
|
<p><strong>Comprehensive Pipeline</strong>:</p>
|
|
<pre><code class="lang-yaml"># .github/workflows/pipeline.yml
|
|
name: Full Pipeline
|
|
|
|
on:
|
|
push:
|
|
branches: [main]
|
|
|
|
jobs:
|
|
# Stage 1: Build
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
- name: Build Docker image
|
|
run: docker build -t myapp:${{ github.sha }} .
|
|
- name: Push to registry
|
|
run: docker push myapp:${{ github.sha }}
|
|
|
|
# Stage 2: Test
|
|
test:
|
|
needs: build
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
- name: Unit tests
|
|
run: npm test
|
|
- name: Integration tests
|
|
run: npm run test:integration
|
|
- name: E2E tests
|
|
run: npm run test:e2e
|
|
|
|
# Stage 3: Security scan
|
|
security:
|
|
needs: build
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
- name: Run Snyk scan
|
|
uses: snyk/actions/node@master
|
|
env:
|
|
SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
|
|
|
|
# Stage 4: Deploy to staging
|
|
deploy-staging:
|
|
needs: [test, security]
|
|
runs-on: ubuntu-latest
|
|
environment: staging
|
|
steps:
|
|
- name: Deploy to staging
|
|
run: |
|
|
kubectl set image deployment/myapp \
|
|
myapp=myapp:${{ github.sha }} \
|
|
-n staging
|
|
|
|
# Stage 5: Deploy to production (manual approval)
|
|
deploy-production:
|
|
needs: deploy-staging
|
|
runs-on: ubuntu-latest
|
|
environment: production
|
|
steps:
|
|
- name: Deploy to production
|
|
run: |
|
|
kubectl set image deployment/myapp \
|
|
myapp=myapp:${{ github.sha }} \
|
|
-n production</code></pre>
|
|
<hr>
|
|
<h3>Pattern 3: Quality Gates</h3>
|
|
<p><strong>Fail Build on Quality Issues</strong>:</p>
|
|
<pre><code class="lang-yaml">- name: Check code coverage
|
|
run: |
|
|
pytest --cov=src --cov-fail-under=80
|
|
# Fails if coverage < 80%
|
|
|
|
- name: Check code complexity
|
|
run: |
|
|
radon cc src/ -a -nb --total-average-threshold=B
|
|
# Fails if complexity > B grade
|
|
|
|
- name: Check for vulnerabilities
|
|
run: |
|
|
safety check
|
|
# Fails if known vulnerabilities found
|
|
|
|
- name: Check for code duplication
|
|
run: |
|
|
jscpd src/ --threshold 5
|
|
# Fails if > 5% duplication
|
|
|
|
- name: Check for linting errors
|
|
run: |
|
|
eslint src/ --max-warnings=0
|
|
# Fails on any warnings</code></pre>
|
|
<hr>
|
|
<h3>Pattern 4: Blue-Green Deployment</h3>
|
|
<pre><code class="lang-yaml"># Blue-Green deployment strategy
|
|
- name: Deploy to green environment
|
|
run: |
|
|
# Deploy new version to "green" environment
|
|
kubectl apply -f k8s/green/ -n production
|
|
|
|
- name: Run smoke tests on green
|
|
run: |
|
|
curl https://green.myapp.com/health
|
|
npm run test:smoke -- --url=https://green.myapp.com
|
|
|
|
- name: Switch traffic to green
|
|
run: |
|
|
# Switch load balancer to green
|
|
kubectl patch service myapp \
|
|
-p '{"spec":{"selector":{"version":"green"}}}' \
|
|
-n production
|
|
|
|
- name: Monitor green for 10 minutes
|
|
run: |
|
|
# Monitor error rates, latency
|
|
sleep 600
|
|
|
|
- name: Destroy blue environment
|
|
run: |
|
|
kubectl delete -f k8s/blue/ -n production</code></pre>
|
|
<hr>
|
|
<h3>Pattern 5: Canary Deployment</h3>
|
|
<pre><code class="lang-yaml"># Gradual rollout to production
|
|
- name: Deploy canary (5% traffic)
|
|
run: |
|
|
kubectl set image deployment/myapp-canary \
|
|
myapp=myapp:${{ github.sha }}
|
|
kubectl scale deployment/myapp-canary --replicas=1
|
|
|
|
- name: Monitor canary for 15 minutes
|
|
run: |
|
|
# Check error rates, latency
|
|
if [ $ERROR_RATE -gt $THRESHOLD ]; then
|
|
echo "Canary failed, rolling back"
|
|
exit 1
|
|
fi
|
|
|
|
- name: Increase to 25% traffic
|
|
run: |
|
|
kubectl scale deployment/myapp-canary --replicas=5
|
|
|
|
- name: Monitor for 15 minutes
|
|
run: |
|
|
# Check metrics again
|
|
sleep 900
|
|
|
|
- name: Full rollout (100% traffic)
|
|
run: |
|
|
kubectl set image deployment/myapp \
|
|
myapp=myapp:${{ github.sha }}
|
|
kubectl delete deployment/myapp-canary</code></pre>
|
|
<hr>
|
|
<h3>Pattern 6: Feature Flags</h3>
|
|
<p><strong>Deploy code without enabling features</strong>:</p>
|
|
<pre><code class="lang-python"># Deploy with feature disabled
|
|
from feature_flags import is_enabled
|
|
|
|
@app.route("/api/users")
|
|
def get_users():
|
|
if is_enabled("new_user_endpoint"):
|
|
return new_get_users() # New implementation
|
|
else:
|
|
return old_get_users() # Old implementation
|
|
|
|
# Configuration
|
|
# feature_flags.yaml
|
|
features:
|
|
new_user_endpoint:
|
|
enabled: false # Deploy code, don't enable yet
|
|
rollout_percentage: 0
|
|
|
|
# Gradual rollout
|
|
# 1. Deploy code with flag disabled
|
|
# 2. Enable for 5% of users
|
|
# 3. Monitor metrics
|
|
# 4. Increase to 25%, 50%, 100%
|
|
# 5. Remove flag after full rollout</code></pre>
|
|
<hr>
|
|
<h3>Pattern 7: Automated Rollback</h3>
|
|
<pre><code class="lang-yaml">- name: Deploy new version
|
|
id: deploy
|
|
run: |
|
|
kubectl set image deployment/myapp myapp:${{ github.sha }}
|
|
kubectl rollout status deployment/myapp
|
|
|
|
- name: Monitor deployment
|
|
id: monitor
|
|
run: |
|
|
# Check error rates for 5 minutes
|
|
ERROR_RATE=$(check_error_rate)
|
|
if [ $ERROR_RATE -gt 5 ]; then
|
|
echo "Error rate too high: $ERROR_RATE%"
|
|
exit 1
|
|
fi
|
|
|
|
- name: Rollback on failure
|
|
if: failure()
|
|
run: |
|
|
echo "Deployment failed, rolling back"
|
|
kubectl rollout undo deployment/myapp
|
|
# Send alert to team
|
|
curl -X POST $SLACK_WEBHOOK \
|
|
-d '{"text":"Deployment rolled back due to high error rate"}'</code></pre>
|
|
<hr>
|
|
<h2>Best Practices</h2>
|
|
<h3>CI/CD Guidelines</h3>
|
|
<p><strong>Do's</strong>:</p>
|
|
<ul><li>Keep builds fast (< 10 min)</li><li>Run tests on every commit</li><li>Fail fast (quick feedback)</li><li>Automate everything</li><li>Use quality gates</li><li>Monitor deployments</li><li>Have rollback plan</li><li>Test deployment process</li></ul>
|
|
<p><strong>Don'ts</strong>:</p>
|
|
<ul><li>Don't commit to broken build</li><li>Don't skip tests to save time</li><li>Don't deploy manually</li><li>Don't ignore failing tests</li><li>Don't deploy on Friday (unless CD)</li><li>Don't skip staging environment</li><li>Don't deploy without monitoring</li></ul>
|
|
<hr>
|
|
<h3>Build Optimization</h3>
|
|
<p><strong>Slow Build</strong> (15 minutes):</p>
|
|
<pre><code class="lang-yaml">- name: Install dependencies
|
|
run: npm install # Downloads every time
|
|
|
|
- name: Run all tests
|
|
run: npm test # Runs everything</code></pre>
|
|
<p><strong>Fast Build</strong> (5 minutes):</p>
|
|
<pre><code class="lang-yaml">- name: Cache dependencies
|
|
uses: actions/cache@v3
|
|
with:
|
|
path: ~/.npm
|
|
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
|
|
|
|
- name: Install dependencies
|
|
run: npm ci # Faster than npm install
|
|
|
|
- name: Run unit tests (fast)
|
|
run: npm run test:unit
|
|
|
|
- name: Run integration tests (parallel)
|
|
run: npm run test:integration -- --parallel
|
|
|
|
# E2E tests run only on main branch
|
|
- name: Run E2E tests
|
|
if: github.ref == 'refs/heads/main'
|
|
run: npm run test:e2e</code></pre>
|
|
<hr>
|
|
<h2>Anti-Patterns</h2>
|
|
<h3>Common CI/CD Mistakes</h3>
|
|
<pre><code>❌ Manual Deployment Steps
|
|
→ "SSH into server and run deploy.sh"
|
|
✅ Fully automated deployment
|
|
|
|
❌ No Tests in CI
|
|
→ "We'll test it manually"
|
|
✅ Automated tests on every commit
|
|
|
|
❌ Long-Running Builds
|
|
→ 30+ minute builds
|
|
✅ Optimize to < 10 minutes
|
|
|
|
❌ Ignoring Broken Builds
|
|
→ "I'll fix it later"
|
|
✅ Fix immediately or revert
|
|
|
|
❌ Deploying Without Monitoring
|
|
→ "Hope it works!"
|
|
✅ Monitor metrics and auto-rollback
|
|
|
|
❌ No Staging Environment
|
|
→ Test in production
|
|
✅ Deploy to staging first
|
|
|
|
❌ Big Bang Deployments
|
|
→ Deploy everything at once
|
|
✅ Incremental rollouts (canary)</code></pre>
|
|
<hr>
|
|
<h2>Platform Examples</h2>
|
|
<h3>GitHub Actions</h3>
|
|
<pre><code class="lang-yaml">name: CI
|
|
on: [push, pull_request]
|
|
jobs:
|
|
test:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
- run: npm test</code></pre>
|
|
<h3>GitLab CI</h3>
|
|
<pre><code class="lang-yaml"># .gitlab-ci.yml
|
|
stages:
|
|
- test
|
|
- deploy
|
|
|
|
test:
|
|
stage: test
|
|
script:
|
|
- npm test
|
|
|
|
deploy:
|
|
stage: deploy
|
|
script:
|
|
- kubectl apply -f k8s/
|
|
only:
|
|
- main</code></pre>
|
|
<h3>CircleCI</h3>
|
|
<pre><code class="lang-yaml"># .circleci/config.yml
|
|
version: 2.1
|
|
jobs:
|
|
test:
|
|
docker:
|
|
- image: node:18
|
|
steps:
|
|
- checkout
|
|
- run: npm test
|
|
|
|
workflows:
|
|
test-deploy:
|
|
jobs:
|
|
- test</code></pre>
|
|
<h3>Jenkins</h3>
|
|
<pre><code class="lang-groovy">pipeline {
|
|
agent any
|
|
stages {
|
|
stage('Test') {
|
|
steps {
|
|
sh 'npm test'
|
|
}
|
|
}
|
|
stage('Deploy') {
|
|
steps {
|
|
sh 'kubectl apply -f k8s/'
|
|
}
|
|
}
|
|
}
|
|
}</code></pre>
|
|
<hr>
|
|
<h2>Monitoring & Observability</h2>
|
|
<p><strong>Key Metrics</strong>:</p>
|
|
<pre><code>Deployment Frequency: How often we deploy
|
|
Lead Time: Time from commit to production
|
|
Change Failure Rate: % of deployments that fail
|
|
Mean Time to Recovery: Time to fix production issues
|
|
|
|
DORA Metrics Targets:
|
|
- Elite: Multiple deploys/day, < 1 hour lead time
|
|
- High: Weekly to daily deploys, < 1 day lead time
|
|
- Medium: Monthly to weekly, 1 week lead time
|
|
- Low: < Monthly, > 6 months lead time</code></pre>
|
|
<p><strong>Health Checks</strong>:</p>
|
|
<pre><code class="lang-python">@app.route("/health")
|
|
def health():
|
|
return {
|
|
"status": "healthy",
|
|
"version": os.getenv("VERSION"),
|
|
"database": check_database(),
|
|
"cache": check_cache(),
|
|
}
|
|
|
|
@app.route("/ready")
|
|
def readiness():
|
|
# Check if app is ready to serve traffic
|
|
if not is_database_ready():
|
|
return {"status": "not ready"}, 503
|
|
return {"status": "ready"}</code></pre>
|
|
<hr>
|
|
<h2>Related Skills</h2>
|
|
<ul><li><strong>engineering-test-driven-development</strong>: TDD enables fast CI</li><li><strong>engineering-code-review</strong>: Automated checks in CI</li><li><strong>engineering-code-quality</strong>: Quality gates in pipeline</li><li><strong>engineering-technical-debt</strong>: CI prevents debt accumulation</li></ul>
|
|
<hr>
|
|
<h2>References</h2>
|
|
<ul><li><a href="https://www.amazon.com/Continuous-Delivery-Deployment-Automation-Addison-Wesley/dp/0321601912">Continuous Delivery by Jez Humble</a></li><li><a href="https://www.amazon.com/Phoenix-Project-DevOps-Helping-Business/dp/0988262592">The Phoenix Project by Gene Kim</a></li><li><a href="https://www.amazon.com/Accelerate-Software-Performing-Technology-Organizations/dp/1942788339">Accelerate by Nicole Forsgren</a></li><li><a href="https://docs.github.com/en/actions">GitHub Actions Documentation</a></li></ul>
|
|
<footer>
|
|
<div class="fmap">
|
|
<div><b>Build</b>
|
|
<a href="https://hanzo.app">hanzo.app</a> app builder
|
|
<a href="https://hanzo.codes">hanzo.codes</a> code with an agent
|
|
<a href="https://hanzoskills.com">hanzoskills.com</a> what an agent reads</div>
|
|
<div><b>Run</b>
|
|
<a href="https://console.hanzo.ai">console.hanzo.ai</a> cloud console
|
|
<a href="https://api.hanzo.ai">api.hanzo.ai</a> the API</div>
|
|
<div><b>Account</b>
|
|
<a href="https://hanzo.id">hanzo.id</a> sign in
|
|
<a href="https://pay.hanzo.ai">pay.hanzo.ai</a> top up
|
|
<a href="https://billing.hanzo.ai">billing.hanzo.ai</a> invoices and usage</div>
|
|
<div><b>Company</b>
|
|
<a href="https://hanzo.ai">hanzo.ai</a> canonical
|
|
<a href="https://hanzo.ventures">hanzo.ventures</a> ventures</div>
|
|
</div>
|
|
<div class="fend"><a href="/engineering-continuous-integration.md">This page as plain text</a> · <a href="/llms.txt">Index for agents</a></div>
|
|
</footer>
|
|
</div></body></html> |