1# GitHub Actions
2 
3Complete setup guide for Turborepo with GitHub Actions.
4 
5## Basic Workflow Structure
6 
7```yaml
8name: CI
9 
10on:
11  push:
12    branches: [main]
13  pull_request:
14    branches: [main]
15 
16jobs:
17  build:
18    runs-on: ubuntu-latest
19    steps:
20      - uses: actions/checkout@v4
21        with:
22          fetch-depth: 2
23 
24      - uses: actions/setup-node@v4
25        with:
26          node-version: 20
27 
28      - name: Install dependencies
29        run: npm ci
30 
31      - name: Build and Test
32        run: turbo run build test lint
33```
34 
35## Package Manager Setup
36 
37### pnpm
38 
39```yaml
40- uses: pnpm/action-setup@v3
41  with:
42    version: 9
43 
44- uses: actions/setup-node@v4
45  with:
46    node-version: 20
47    cache: "pnpm"
48 
49- run: pnpm install --frozen-lockfile
50```
51 
52### Yarn
53 
54```yaml
55- uses: actions/setup-node@v4
56  with:
57    node-version: 20
58    cache: "yarn"
59 
60- run: yarn install --frozen-lockfile
61```
62 
63### Bun
64 
65```yaml
66- uses: oven-sh/setup-bun@v1
67  with:
68    bun-version: latest
69 
70- run: bun install --frozen-lockfile
71```
72 
73## Remote Cache Setup
74 
75### 1. Create Vercel Access Token
76 
771. Go to [Vercel Dashboard](https://vercel.com/account/tokens)
782. Create a new token with appropriate scope
793. Copy the token value
80 
81### 2. Add Secrets and Variables
82 
83In your GitHub repository settings:
84 
85**Secrets** (Settings > Secrets and variables > Actions > Secrets):
86 
87- `TURBO_TOKEN`: Your Vercel access token
88 
89**Variables** (Settings > Secrets and variables > Actions > Variables):
90 
91- `TURBO_TEAM`: Your Vercel team slug
92 
93### 3. Add to Workflow
94 
95```yaml
96jobs:
97  build:
98    runs-on: ubuntu-latest
99    env:
100      TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
101      TURBO_TEAM: ${{ vars.TURBO_TEAM }}
102```
103 
104## Alternative: actions/cache
105 
106If you can't use remote cache, cache Turborepo's local cache directory:
107 
108```yaml
109- uses: actions/cache@v4
110  with:
111    path: .turbo
112    key: turbo-${{ runner.os }}-${{ hashFiles('**/turbo.json', '**/package-lock.json') }}
113    restore-keys: |
114      turbo-${{ runner.os }}-
115```
116 
117Note: This is less effective than remote cache since it's per-branch.
118 
119## Complete Example
120 
121```yaml
122name: CI
123 
124on:
125  push:
126    branches: [main]
127  pull_request:
128    branches: [main]
129 
130jobs:
131  build:
132    runs-on: ubuntu-latest
133    env:
134      TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
135      TURBO_TEAM: ${{ vars.TURBO_TEAM }}
136 
137    steps:
138      - uses: actions/checkout@v4
139        with:
140          fetch-depth: 2
141 
142      - uses: pnpm/action-setup@v3
143        with:
144          version: 9
145 
146      - uses: actions/setup-node@v4
147        with:
148          node-version: 20
149          cache: "pnpm"
150 
151      - name: Install dependencies
152        run: pnpm install --frozen-lockfile
153 
154      - name: Build
155        run: turbo run build --affected
156 
157      - name: Test
158        run: turbo run test --affected
159 
160      - name: Lint
161        run: turbo run lint --affected
162```
163