GitHub Actions: Workflow Syntax and Triggers

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"

# Basic YAML structure for a workflow.

name: Node.js CI

# Use a descriptive workflow name.

on:
  push:
    branches:
      - main
      - develop

# Trigger on pushes to specific branches.

on:
  pull_request:
    branches: [main]

# Trigger on pull requests for review pipelines.

on:
  workflow_dispatch:

# Enable workflow_dispatch for manual execution.

on:
  workflow_dispatch:
    inputs:
      environment:
        description: Deploy target
        required: true
        default: staging
        type: choice
        options:
          - staging
          - production

# Prompt for environment or other runtime parameters.

on:
  schedule:
    - cron: "0 6 * * 1-5"

# Schedule workflows using cron syntax in UTC.

on:
  push:
    paths:
      - "src/**"
      - "package.json"
      - ".github/workflows/ci.yml"

# Use `paths` to scope the workflow to files or directories.

on:
  pull_request:
    paths-ignore:
      - "docs/**"
      - "**/*.md"

# Exclude paths that should not trigger CI.

concurrency:
  group: ci-${{ github.ref }}
  cancel-in-progress: true

# Use concurrency groups to keep only the latest run active.

jobs:
  test:
    runs-on: ubuntu-latest
    timeout-minutes: 20

# Prevent jobs from hanging forever.

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - run: npm test

  deploy:
    needs: test
    runs-on: ubuntu-latest
    steps:
      - run: echo "Deploying..."

# Run a deploy only after tests succeed.