{"slug":"github-actions-cicd","title":"CI/CD Pipeline with GitHub Actions: Complete Guide","description":"Build a robust CI/CD pipeline using GitHub Actions for automated testing, building, and deployment","date":"2024-03-05","author":"Elaph Hilful","thumbnail":"/blog-images/github-actions.webp","tags":["CI/CD","GitHub Actions","DevOps","Automation"],"category":"DevOps","featured":false,"readTime":4,"htmlContent":"

Continuous Integration and Continuous Deployment (CI/CD) are essential practices in modern software development. GitHub Actions provides a powerful, integrated way to automate your workflows directly from your repository.

\n

Why GitHub Actions?

\n

GitHub Actions offers several advantages:

\n\n

Basic Workflow Structure

\n
name: CI Pipeline\n\non:\n  push:\n    branches: [main, develop]\n  pull_request:\n    branches: [main]\n\njobs:\n  build:\n    runs-on: ubuntu-latest\n\n    steps:\n      - uses: actions/checkout@v3\n\n      - name: Setup Node.js\n        uses: actions/setup-node@v3\n        with:\n          node-version: \"18\"\n\n      - name: Install dependencies\n        run: npm ci\n\n      - name: Run tests\n        run: npm test\n\n      - name: Build\n        run: npm run build\n
\n

Advanced Features

\n

Matrix Strategy

\n

Test across multiple versions and platforms:

\n
jobs:\n  test:\n    runs-on: ${{ matrix.os }}\n    strategy:\n      matrix:\n        os: [ubuntu-latest, windows-latest, macos-latest]\n        node-version: [16, 18, 20]\n\n    steps:\n      - uses: actions/checkout@v3\n      - name: Setup Node.js ${{ matrix.node-version }}\n        uses: actions/setup-node@v3\n        with:\n          node-version: ${{ matrix.node-version }}\n      - run: npm ci\n      - run: npm test\n
\n

Caching Dependencies

\n

Speed up workflows by caching dependencies:

\n
- name: Cache node modules\n  uses: actions/cache@v3\n  with:\n    path: ~/.npm\n    key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}\n    restore-keys: |\n      ${{ runner.os }}-node-\n
\n

Docker Integration

\n

Build and push Docker images:

\n
- name: Set up Docker Buildx\n  uses: docker/setup-buildx-action@v2\n\n- name: Login to DockerHub\n  uses: docker/login-action@v2\n  with:\n    username: ${{ secrets.DOCKERHUB_USERNAME }}\n    password: ${{ secrets.DOCKERHUB_TOKEN }}\n\n- name: Build and push\n  uses: docker/build-push-action@v4\n  with:\n    context: .\n    push: true\n    tags: user/app:latest\n    cache-from: type=gha\n    cache-to: type=gha,mode=max\n
\n

Deployment Workflows

\n

Deploy to AWS

\n
- name: Configure AWS credentials\n  uses: aws-actions/configure-aws-credentials@v2\n  with:\n    aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}\n    aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}\n    aws-region: us-east-1\n\n- name: Deploy to ECS\n  run: |\n    aws ecs update-service --cluster my-cluster \\\n      --service my-service --force-new-deployment\n
\n

Deploy to Kubernetes

\n
- name: Setup kubectl\n  uses: azure/setup-kubectl@v3\n\n- name: Deploy to Kubernetes\n  run: |\n    kubectl config set-context --current --namespace=production\n    kubectl apply -f k8s/\n    kubectl rollout status deployment/myapp\n
\n

Security Best Practices

\n

Use Secrets

\n

Never hardcode sensitive information:

\n
- name: Run deployment\n  env:\n    API_KEY: ${{ secrets.API_KEY }}\n    DB_PASSWORD: ${{ secrets.DB_PASSWORD }}\n  run: ./deploy.sh\n
\n

Dependency Scanning

\n
- name: Run Snyk to check for vulnerabilities\n  uses: snyk/actions/node@master\n  env:\n    SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}\n
\n

Code Scanning

\n
- name: Initialize CodeQL\n  uses: github/codeql-action/init@v2\n  with:\n    languages: javascript\n\n- name: Perform CodeQL Analysis\n  uses: github/codeql-action/analyze@v2\n
\n

Complete Production Pipeline

\n
name: Production Pipeline\n\non:\n  push:\n    branches: [main]\n\njobs:\n  test:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v3\n      - name: Setup Node.js\n        uses: actions/setup-node@v3\n        with:\n          node-version: \"18\"\n      - run: npm ci\n      - run: npm test\n      - run: npm run lint\n\n  build:\n    needs: test\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v3\n      - name: Build Docker image\n        uses: docker/build-push-action@v4\n        with:\n          context: .\n          push: true\n          tags: |\n            myregistry/app:latest\n            myregistry/app:${{ github.sha }}\n\n  deploy:\n    needs: build\n    runs-on: ubuntu-latest\n    steps:\n      - name: Deploy to production\n        uses: appleboy/ssh-action@master\n        with:\n          host: ${{ secrets.PROD_HOST }}\n          username: ${{ secrets.PROD_USER }}\n          key: ${{ secrets.SSH_KEY }}\n          script: |\n            cd /app\n            docker-compose pull\n            docker-compose up -d\n
\n

Monitoring and Notifications

\n

Slack Notifications

\n
- name: Notify Slack\n  if: always()\n  uses: 8398a7/action-slack@v3\n  with:\n    status: ${{ job.status }}\n    text: \"Deployment to production completed\"\n    webhook_url: ${{ secrets.SLACK_WEBHOOK }}\n
\n

Best Practices Checklist

\n\n

Conclusion

\n

GitHub Actions provides a powerful, flexible platform for building CI/CD pipelines. Start with simple workflows and gradually add complexity as your needs grow.

\n

The integration with GitHub's ecosystem makes it an excellent choice for teams already using GitHub for version control.

\n

Resources

\n"}