github-actions
Write and debug GitHub Actions workflows. Use when the user says "create CI pipeline", "github actions", "workflow not working", "fix CI", "automate with github", or asks about GitHub Actions.
When & Why to Use This Skill
This Claude skill empowers developers to efficiently design, implement, and troubleshoot GitHub Actions workflows. It streamlines the creation of robust CI/CD pipelines by enforcing industry best practices, such as minimal permission sets and pinned action versions, ensuring secure and reliable automation for software delivery.
Use Cases
- Automating CI/CD pipelines: Quickly generate standardized YAML configurations for building, testing, and deploying applications across various environments.
- Troubleshooting workflow failures: Analyze GitHub Actions run logs and use integrated CLI commands to identify and resolve configuration or runtime errors efficiently.
- Performance optimization: Implement advanced features like dependency caching, matrix builds, and concurrency management to significantly reduce build times and resource usage.
- Security hardening: Audit and update existing workflows to use specific commit SHAs, minimal permissions, and secure secret management to prevent supply chain vulnerabilities.
| name | github-actions |
|---|---|
| description | Write and debug GitHub Actions workflows. Use when the user says "create CI pipeline", "github actions", "workflow not working", "fix CI", "automate with github", or asks about GitHub Actions. |
| allowed-tools | Read, Write, Edit, Glob, Grep, Bash |
GitHub Actions
Create and troubleshoot GitHub Actions workflows for CI/CD pipelines.
Instructions
When writing:
- Understand the pipeline requirements
- Check existing workflows in
.github/workflows/ - Write workflow following best practices below
- Validate with
actionlintif available
When debugging:
- Read the workflow file
- Check recent runs:
gh run list - View run logs:
gh run view <run-id> --log-failed - Identify and fix issues
Workflow structure
name: CI
on:
push:
branches: [main]
pull_request:
branches: [main]
permissions:
contents: read
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: "20"
cache: "npm"
- name: Install dependencies
run: npm ci
- name: Run tests
run: npm test
Best practices
- MUST pin actions to full SHA:
uses: actions/checkout@abc123... - MUST set minimal
permissions:(not defaults) - MUST use
npm cinotnpm installfor reproducibility - Use caching for dependencies
- Use matrix builds for multiple versions
- Use job dependencies with
needs: - Use concurrency to cancel outdated runs
- Store secrets in GitHub Secrets, reference with
${{ secrets.NAME }}
Security
permissions:
contents: read # Minimal permissions
env:
API_KEY: ${{ secrets.API_KEY }} # Never hardcode
Common patterns
# Caching
- uses: actions/cache@v4
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
# Matrix
strategy:
matrix:
node: [18, 20, 22]
os: [ubuntu-latest, macos-latest]
# Concurrency
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
# Conditional
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
Debug commands
gh run list --limit 10
gh run view <run-id>
gh run view <run-id> --log-failed
gh run rerun <run-id>
Rules
- MUST use pinned action versions (SHA or version tag)
- MUST set explicit permissions
- Never hardcode secrets in workflow files
- Never use
pull_request_targetwith checkout of PR code - Always test workflows in a branch first