Workflow YAML structure, common triggers, path filters, schedule, workflow_dispatch, concurrency, and job basics for GitHub Actions.
Start with the core keys every workflow uses.
name: CI
on:
push:
branches: [main]
pull_request:
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- run: echo "Hello from GitHub Actions"Workflows live under `.github/workflows/*.yml` and define triggers, jobs, and steps.
name: Node.js CIA clear name helps people quickly identify runs in the Actions tab and status checks.
on:
push:
branches:
- main
- developUse branch filters to avoid running expensive workflows everywhere.
on:
pull_request:
branches: [main]This is common for lint, test, and build validation before merging.
Enable workflow_dispatch for manual execution.
on:
workflow_dispatch:This adds a Run workflow button in GitHub Actions.
Prompt for environment or other runtime parameters.
on:
workflow_dispatch:
inputs:
environment:
description: Deploy target
required: true
default: staging
type: choice
options:
- staging
- productionInputs are useful for ad hoc deploys, scripts, and maintenance workflows.
on:
schedule:
- cron: "0 6 * * 1-5"Scheduled workflows are good for cleanup, dependency updates, sync jobs, and audits.
Use filters to limit runs and concurrency to cancel duplicates.
Use `paths` to scope the workflow to files or directories.
on:
push:
paths:
- "src/**"
- "package.json"
- ".github/workflows/ci.yml"Path filters save minutes and cost by skipping unrelated changes.
on:
pull_request:
paths-ignore:
- "docs/**"
- "**/*.md"Useful when docs edits do not need a full build pipeline.
Use concurrency groups to keep only the latest run active.
concurrency:
group: ci-${{ github.ref }}
cancel-in-progress: trueThis is especially valuable on busy branches where every new push supersedes the prior run.
jobs:
test:
runs-on: ubuntu-latest
timeout-minutes: 20Timeouts keep queues healthy and cap costs when a process hangs.
jobs:
test:
runs-on: ubuntu-latest
steps:
- run: npm test
deploy:
needs: test
runs-on: ubuntu-latest
steps:
- run: echo "Deploying..."`needs` defines job dependencies and helps structure staged pipelines.