github-actions-cicd

Files (8)

• SKILL.md
• ci-pipeline.yml · assets/templates/
• deploy-multi-env.yml · assets/templates/
• BEST_PRACTICES.md · references/
• SYNTAX_REFERENCE.md · references/
• TROUBLESHOOTING.md · references/
• analyze_workflow.py · scripts/
• validate_syntax.sh · scripts/

SKILL.md (first lines)

# GitHub Actions CI/CD Specialist

Expert guidance on implementing, debugging, and optimizing GitHub Actions workflows for CI/CD pipelines.

## When to Use This Skill

Activate this skill when the user:
- Wants to create or modify a `.github/workflows/*.yml` file
- Experiences workflow failures and needs troubleshooting help
- Asks about matrix builds, caching strategies, or secrets management
- Needs guidance on CI/CD best practices
- Wants to optimize pipeline performance

## Core Workflow Structure

### Basic Template

```yaml
name: CI Pipeline
on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

permissions:
  contents: read

env:
  NODE_ENV: production

jobs:
  build:
    runs-on: ubuntu-latest
    timeout-minutes: 15
    steps:
      - uses: actions/checkout@v4
      
      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: '20'
          cache: 'npm'
      
      - run: npm ci
      - run: npm test
```

## Key Implementation Guidelines

### 1. Workflow Triggers (`on`)

Choose appropriate triggers to balance responsiveness and cost:

| Trigger Type | Use Case | Example |
|-------------|----------|---------|
| `push` | Main branch deployments | `branches: [main, develop]` |
| `pull_request` | PR validation | `branches: [main]` |
| `workflow_dispatch` | Manual triggering | For ad-hoc runs |
| `schedule` | Periodic jobs | `cron: '0 0 * * *'` |

**Best Practice**: Use paths to filter irrelevant changes:
```yaml
on:
  push:
    branches: [main]
    paths:
      - 'src/**'
      - '.github/workflows/*.yml'
```

### 2. Job Configuration

Each job should have:
- **`runs-on`**: Specify runner (ubuntu-latest, windows-latest, self-hosted)
- **`timeout-minutes`**: Prevent hung jobs (recommended: 15-30 min for CI)
- **`env`**: Job-level environment variables
- **`needs`**: Dependencies on other jobs

**Example:**
```yaml
jobs:
  test:
    runs-on: ubuntu-latest
    timeout-minutes: 20
    env:
      CI: true
    strategy:
      matrix:
        node-version: [18, 20, 22]
    steps:
```

### 3. Matrix Strategy for Parallel Testing

Use matrices to test across multiple configurations:

```yaml
strategy:
  fail-fast: false  # Continue all jobs even if one fails
  matrix:
    node-version: [18, 20, 22]
    os: [ubuntu-latest, windows-latest]
```

**Advanced Matrix Patterns:**

- **Include specific combinations**:
```yaml
strategy:
  matrix:
    include:
      - node: 20
        experimental: false
      - node: 21
        experimental: true
```

- **Dynamic matrices based on code changes**:

From Kubementat/ai_agent_skills, MIT.

More from Kubementat/ai_agent_skills