GitHub Actions

1
on:
2
  # Run on pushes to main, but only when source or workflows change
3
  push:
4
    branches: [main]
5
    paths:
6
      - 'src/**'
7
      - '.github/workflows/**'
8
  # Run on PRs targeting main, ignoring docs-only changes
9
  pull_request:
10
    branches: [main]
11
    paths-ignore:
12
      - '**.md'

1
on:
2
  # Cron runs in UTC. This is 02:00 UTC every day.
3
  schedule:
4
    - cron: '0 2 * * *'
5
  # A "Run workflow" button in the Actions tab, with inputs
6
  workflow_dispatch:
7
    inputs:
8
      environment:
9
        description: 'Target environment'
10
        type: choice
11
        options: [staging, production]
12
        default: staging

1
on:
2
  workflow_call:
3
    inputs:
4
      node-version:
5
        required: false
6
        type: string
7
        default: '20'
8
    secrets:
9
      npm-token:
10
        required: true

1
jobs:
2
  build:
3
    runs-on: ubuntu-latest
4
    steps:
5
      - run: echo "building"
6

7
  deploy:
8
    # Wait for build, and only deploy from main
9
    needs: build
10
    if: github.ref == 'refs/heads/main'
11
    runs-on: ubuntu-latest
12
    environment: production
13
    steps:
14
      - run: echo "deploying"

1
jobs:
2
  test:
3
    runs-on: ${{ matrix.os }}
4
    strategy:
5
      matrix:
6
        os: [ubuntu-latest, macos-latest, windows-latest]
7
    steps:
8
      - uses: actions/checkout@v4
9
      - run: echo "testing on ${{ matrix.os }}"

1
steps:
2
  # An action from the marketplace, pinned to a major version
3
  - uses: actions/checkout@v4
4

5
  - uses: actions/setup-node@v4
6
    with:
7
      node-version: '20'
8
      cache: 'npm'
9

10
  # A multi-line shell command with a step id and env
11
  - name: Build
12
    id: build
13
    env:
14
      NODE_ENV: production
15
    run: |
16
      npm ci
17
      npm run build

1
env:
2
  APP_NAME: my-app        # available to every job and step
3

4
jobs:
5
  build:
6
    runs-on: ubuntu-latest
7
    env:
8
      LOG_LEVEL: debug    # available to every step in this job
9
    steps:
10
      - name: One-off value
11
        env:
12
          STAGE: build     # only this step
13
        run: echo "$APP_NAME $LOG_LEVEL $STAGE"
14

15
      - name: Export to later steps
16
        # Writing to $GITHUB_ENV persists a var to the next steps
17
        run: echo "VERSION=1.2.3" >> "$GITHUB_ENV"

1
jobs:
2
  publish:
3
    runs-on: ubuntu-latest
4
    steps:
5
      - env:
6
          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
7
        run: npm publish
8

9
  call-shared:
10
    uses: ./.github/workflows/deploy.yml
11
    # Forward a named secret to the reusable workflow
12
    secrets:
13
      npm-token: ${{ secrets.NPM_TOKEN }}
14
    # Or hand over everything the caller has:
15
    # secrets: inherit

1
# Default to read-only for the whole workflow
2
permissions:
3
  contents: read
4

5
jobs:
6
  release:
7
    runs-on: ubuntu-latest
8
    # Grant just what this job needs
9
    permissions:
10
      contents: write
11
      packages: write
12
    steps:
13
      - run: gh release create v1.0.0
14
        env:
15
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

1
strategy:
2
  # Keep other jobs running if one combo fails
3
  fail-fast: false
4
  # Cap parallel jobs so you don't exhaust runners
5
  max-parallel: 4
6
  matrix:
7
    node: [18, 20, 22]
8
    os: [ubuntu-latest, windows-latest]
9
    # Drop a combo that isn't supported
10
    exclude:
11
      - node: 18
12
        os: windows-latest
13
    # Add an extra one-off combo with a custom flag
14
    include:
15
      - node: 22
16
        os: ubuntu-latest
17
        experimental: true

1
- uses: actions/cache@v4
2
  with:
3
    path: ~/.npm
4
    # Exact key: changes when the lockfile changes
5
    key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}
6
    # Fallback prefixes for a partial (warm) restore
7
    restore-keys: |
8
      ${{ runner.os }}-npm-

1
jobs:
2
  build:
3
    runs-on: ubuntu-latest
4
    steps:
5
      - run: npm run build
6
      - uses: actions/upload-artifact@v4
7
        with:
8
          name: dist
9
          path: dist/
10
          retention-days: 7
11

12
  deploy:
13
    needs: build
14
    runs-on: ubuntu-latest
15
    steps:
16
      - uses: actions/download-artifact@v4
17
        with:
18
          name: dist
19
          path: dist/
20
      - run: ls dist/

1
jobs:
2
  deploy:
3
    # Local reusable workflow
4
    uses: ./.github/workflows/deploy.yml
5
    with:
6
      node-version: '20'
7
    secrets:
8
      npm-token: ${{ secrets.NPM_TOKEN }}
9

10
  deploy-shared:
11
    # Reusable workflow from another repo, pinned to a tag
12
    uses: my-org/ci-workflows/.github/workflows/deploy.yml@v2
13
    secrets: inherit