my-notes

GitHub_CICD

1 min read

GitHub CI/CD

Continuous Integration and Continuous Deployment.


πŸ“Š CI/CD Pipeline

graph LR
    A[Code Push] --> B[CI: Lint]
    B --> C[CI: Test]
    C --> D[CI: Build]
    D --> E[CD: Deploy Staging]
    E --> F[CD: E2E Tests]
    F --> G[CD: Deploy Production]

πŸ” Continuous Integration

Complete CI Workflow

name: CI

on:
  push:
    branches: [main, develop]
  pull_request:
    branches: [main]

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: "20"
          cache: "npm"
      - run: npm ci
      - run: npm run lint

  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: "20"
          cache: "npm"
      - run: npm ci
      - run: npm test

  build:
    needs: [lint, test]
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - run: npm ci
      - run: npm run build
      - uses: actions/upload-artifact@v4
        with:
          name: build
          path: dist/

πŸš€ Continuous Deployment

CD to Staging

deploy-staging:
  needs: build
  runs-on: ubuntu-latest
  environment:
    name: staging
    url: https://staging.myapp.com
  steps:
    - uses: actions/download-artifact@v4
      with:
        name: build
    - run: ./deploy.sh staging
      env:
        DEPLOY_KEY: ${{ secrets.STAGING_DEPLOY_KEY }}

Deploys to staging environment.


CD to Production

deploy-production:
  needs: deploy-staging
  runs-on: ubuntu-latest
  environment:
    name: production
    url: https://myapp.com
  steps:
    - uses: actions/download-artifact@v4
      with:
        name: build
    - run: ./deploy.sh production
      env:
        DEPLOY_KEY: ${{ secrets.PROD_DEPLOY_KEY }}

Deploys to production after staging.


πŸ›‘οΈ Environment Protection

Configure in Settings

  1. Go to Settings β†’ Environments
  2. Create environment (staging, production)
  3. Add protection rules:
    • Required reviewers
    • Wait timer
    • Branch restrictions

πŸ“Š Status Checks

Required Checks

Set in branch protection:

  • Require status checks to pass
  • Select required jobs

View Status

gh run list

Shows recent runs.


View Failed Run

gh run view --log-failed

Shows logs of failed jobs.


πŸ”§ CLI Commands

Trigger Deploy

gh workflow run deploy.yml

Manually triggers deployment.


Trigger with Inputs

gh workflow run deploy.yml -f environment=production

Triggers with environment input.


Watch Deployment

gh run watch

Live-watch running deployment.


πŸ’‘ Tips

Rollback Strategy

Keep deployable artifacts tagged for quick rollback.

Deployment Frequency

Deploy to staging on every PR merge, production on releases.



#github #cicd #deploy #automation

Built with mdgarden