coder/.github/workflows/ci.yaml at main · coder/coder · GitHub

View runs

History

1707 lines (1498 loc) · 66.7 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

on:

push:

branches:

- main

- release/*

# GitHub Actions does not reliably trigger push-based CI when a new

# branch is created at a commit that already has a workflow run (e.g.

# from main). The create event fires separately and ensures CI runs

# on newly cut release branches. Non-release branch creations are

# filtered out by the changes job condition.

create:

pull_request:

workflow_dispatch:

permissions:

contents: read

# Cancel in-progress runs for pull requests when developers push

# additional changes

concurrency:

group: ${{ github.workflow }}-${{ github.ref }}

cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}

jobs:

changes:

runs-on: ubuntu-latest

# For create events, only run on release branches to avoid

# triggering CI for every feature branch creation.

if: |

github.event_name != 'create' || (

github.event.ref_type == 'branch' &&

startsWith(github.event.ref, 'release/')

)

outputs:

docs-only: ${{ steps.filter.outputs.docs_count == steps.filter.outputs.all_count }}

docs: ${{ steps.filter.outputs.docs }}

go: ${{ steps.filter.outputs.go }}

site: ${{ steps.filter.outputs.site }}

k8s: ${{ steps.filter.outputs.k8s }}

ci: ${{ steps.filter.outputs.ci }}

db: ${{ steps.filter.outputs.db }}

gomod: ${{ steps.filter.outputs.gomod }}

offlinedocs-only: ${{ steps.filter.outputs.offlinedocs_count == steps.filter.outputs.all_count }}

offlinedocs: ${{ steps.filter.outputs.offlinedocs }}

tailnet-integration: ${{ steps.filter.outputs.tailnet-integration }}

steps:

- name: Harden Runner

uses: step-security/harden-runner@05e31511f85b41b11d1cf0ef85d0992719546e2c # v2.21.0

with:

egress-policy: audit

- name: Checkout

uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

with:

fetch-depth: 1

persist-credentials: false

- name: check changed files

uses: dorny/paths-filter@ceb8a2b8f2d89434be7ff52d3de7ec3738c5cc9d # v4.0.3

id: filter

with:

filters: |

all:

- "**"

docs:

- "docs/**"

- ".claude/docs/**"

- "*.md"

- "examples/web-server/**"

- "examples/monitoring/**"

- "examples/lima/**"

db:

- "**.sql"

- "coderd/database/**"

go:

- "**.sql"

- "**.go"

- "**.golden"

- "go.mod"

- "go.sum"

# Other non-Go files that may affect Go code:

- "**.rego"

- "**.sh"

- "**.tpl"

- "**.gotmpl"

- "**.gotpl"

- "Makefile"

- "site/static/error.html"

# Icon and theme files tested by Go (scripts/gensite):

- "site/static/icon/**"

- "site/src/theme/**"

# Main repo directories for completeness in case other files are

# touched:

- "agent/**"

- "aibridge/**"

- "cli/**"

- "cmd/**"

- "coderd/**"

- "enterprise/**"

- "examples/**"

- "helm/**"

- "provisioner/**"

- "provisionerd/**"

- "provisionersdk/**"

- "pty/**"

- "scaletest/**"

- "tailnet/**"

- "testutil/**"

gomod:

- "go.mod"

- "go.sum"

site:

- "site/**"

k8s:

- "helm/**"

- "scripts/Dockerfile"

- "scripts/Dockerfile.base"

- "scripts/helm.sh"

ci:

- ".github/actions/**"

- ".github/workflows/**"

offlinedocs:

- "offlinedocs/**"

tailnet-integration:

- "tailnet/**"

- "go.mod"

- "go.sum"

- id: debug

run: |

echo "$FILTER_JSON"

env:

FILTER_JSON: ${{ toJSON(steps.filter.outputs) }}

lint-docs:

needs: changes

if: needs.changes.outputs.docs == 'true' || needs.changes.outputs.ci == 'true' || github.ref == 'refs/heads/main'

runs-on: ubuntu-latest

steps:

- name: Harden Runner

uses: step-security/harden-runner@05e31511f85b41b11d1cf0ef85d0992719546e2c # v2.21.0

with:

egress-policy: audit

- name: Checkout

uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

with:

fetch-depth: 1

persist-credentials: false

- name: Set up mise tools

uses: ./.github/actions/setup-mise

with:

install-args: "node pnpm"

- name: Install pnpm dependencies

uses: ./.github/actions/pnpm-install

- name: Check docs

run: pnpm check-docs

# Vale prose linter, advisory only. Scoped to changed Markdown under

# docs/. Every Vale step is `continue-on-error` so this section can

# never block the required `lint-docs` job: a `vale sync` network

# blip or a baseline rule violation surfaces as an annotation, not a

# merge gate. Only markdownlint/table-formatter above stay blocking.

# `vale --no-exit` additionally keeps the baseline error count from

# un-overridden upstream Google rules from failing the step. Lives

# here rather than a standalone workflow so docs lint stays in the

# single required CI umbrella (see #25608). See DOCS-40.

- name: Detect changed Markdown

id: changed-md

continue-on-error: true

uses: tj-actions/changed-files@9426d40962ed5378910ee2e21d5f8c6fcbf2dd96 # v45.0.7

with:

files: |

**.md

separator: ","

# `**.md` (not `docs/**.md`) because the action's globber collapses a

# `**` adjacent to `.md` to a single path segment, so `docs/**.md`

# only matches top-level docs/*.md and misses nested pages such as

# docs/.style/style-guide/README.md. The prose step below re-filters to

# docs/ paths.

# Cache split into restore + conditional save to avoid letting PR

# runs populate a cache that other branches restore from (the

# zizmor `cache-poisoning` concern). Only pushes to the default

# branch may write the cache; PRs may only read it.

- name: Restore Vale styles

id: vale-cache

if: steps.changed-md.outputs.any_changed == 'true'

continue-on-error: true

uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0

with:

# Negation excludes the hand-authored Coder rules from the cache;

# the key also hashes them so a rule change always invalidates it.

# mise manages the Vale binary, so only the synced styles cache.

path: |

docs/.style/styles/*

!docs/.style/styles/Coder

docs/.style/.vale-synced

key: vale-${{ hashFiles('.vale.ini', 'mise.toml', 'docs/.style/styles/Coder/**') }}

restore-keys: |

vale-

- name: Prepare Vale styles

if: steps.changed-md.outputs.any_changed == 'true'

continue-on-error: true

env:

# Non-interactive: let mise auto-install the pinned Vale on first use.

MISE_YES: "1"

run: make docs/.style/.vale-synced

- name: Vale prose lint

if: steps.changed-md.outputs.any_changed == 'true'

continue-on-error: true

env:

ALL_CHANGED_FILES: ${{ steps.changed-md.outputs.all_changed_files }}

# Non-interactive: let mise auto-install the pinned Vale on first use.

MISE_YES: "1"

run: |

# all_changed_files is ACMRD and so lists paths this PR deleted.

# Vale errors on a missing file (--no-exit only suppresses alert

# exits, not runtime errors), so keep only docs/ paths still on

# disk. See DOCS-40.

files=$(printf '%s\n' "$ALL_CHANGED_FILES" \

| tr ',' '\n' \

| grep -E '^docs/' \

| while IFS= read -r f; do [ -f "$f" ] && printf '%s\n' "$f"; done || true)

if [ -z "$files" ]; then

echo "No changed Markdown files under docs/ on disk; skipping Vale."

exit 0

# Vale's --output=line strips per-finding severity, so the

# previous problem-matcher approach collapsed every finding to

# a single hard-coded severity. Use --output=JSON instead and

# emit GitHub workflow commands directly so error/warning/

# suggestion render with their actual Vale severities. URL-

# encode message bodies for `%`, `\r`, and `\n` per the

# GitHub Actions workflow command spec. See DOCS-426.

printf '%s\n' "$files" \

| xargs -d '\n' mise exec "aqua:errata-ai/vale" -- vale --no-exit --output=JSON \

| jq -r '

to_entries[]

| .key as $file

| .value[]

| (if .Severity == "suggestion" then "notice"

elif .Severity == "warning" then "warning"

else "error" end) as $level

| (.Message | gsub("%"; "%25") | gsub("\r"; "%0D") | gsub("\n"; "%0A")) as $msg

| "::\($level) file=\($file),line=\(.Line),col=\(.Span[0]),title=\(.Check)::\($msg)"

- name: Save Vale styles

# Only the default branch is trusted to write the cache, so PR

# runs cannot poison the cache that subsequent runs restore from.

# Skip when the cache already had an exact key hit (no new content).

if: github.ref == 'refs/heads/main' && steps.changed-md.outputs.any_changed == 'true' && steps.vale-cache.outputs.cache-hit != 'true'

continue-on-error: true

uses: actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0

with:

path: |

docs/.style/styles/*

!docs/.style/styles/Coder

docs/.style/.vale-synced

key: ${{ steps.vale-cache.outputs.cache-primary-key }}

# Disabled due to instability. See: https://github.com/coder/coder/issues/14553

# Re-enable once the flake hash calculation is stable.

# update-flake:

# needs: changes

# if: needs.changes.outputs.gomod == 'true'

# runs-on: ${{ github.repository_owner == 'coder' && 'depot-ubuntu-22.04-8' || 'ubuntu-latest' }}

# steps:

# - name: Checkout

# uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

# with:

# fetch-depth: 1

# # See: https://github.com/stefanzweifel/git-auto-commit-action?tab=readme-ov-file#commits-made-by-this-action-do-not-trigger-new-workflow-runs

# token: ${{ secrets.CDRCI_GITHUB_TOKEN }}

# - name: Set up mise tools

# uses: ./.github/actions/setup-mise

# with:

# install-args: "go"

# - name: Update Nix Flake SRI Hash

# run: ./scripts/update-flake.sh

# # auto update flake for dependabot

# - uses: stefanzweifel/git-auto-commit-action@8621497c8c39c72f3e2a999a26b4ca1b5058a842 # v5.0.1

# if: github.actor == 'dependabot[bot]'

# with:

# # Allows dependabot to still rebase!

# commit_message: "[dependabot skip] Update Nix Flake SRI Hash"

# commit_user_name: "dependabot[bot]"

# commit_user_email: "49699333+dependabot[bot]@users.noreply.github.com>"

# commit_author: "dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>"

# # require everyone else to update it themselves

# - name: Ensure No Changes

# if: github.actor != 'dependabot[bot]'

# run: git diff --exit-code

lint:

needs: changes

if: needs.changes.outputs.offlinedocs-only == 'false' || needs.changes.outputs.ci == 'true' || github.ref == 'refs/heads/main'

runs-on: ${{ github.repository_owner == 'coder' && 'depot-ubuntu-22.04-8' || 'ubuntu-latest' }}

steps:

- name: Harden Runner

uses: step-security/harden-runner@05e31511f85b41b11d1cf0ef85d0992719546e2c # v2.21.0

with:

egress-policy: audit

- name: Checkout

uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

with:

# Depth 2 makes the PR merge commit's first parent (the base

# branch tip) available so lint/emdash can diff against HEAD^

# without fetching the base branch at runtime.

fetch-depth: 2

persist-credentials: false

- name: Set up mise tools

uses: ./.github/actions/setup-mise

with:

install-args: "go node pnpm helm aqua:crate-ci/typos"

- name: Install pnpm dependencies

uses: ./.github/actions/pnpm-install

- name: Install Go mise tools

run: ./.github/scripts/retry.sh -- mise install --locked go:github.com/golangci/golangci-lint/v2/cmd/golangci-lint go:github.com/coder/paralleltestctx/cmd/paralleltestctx go:github.com/rhysd/actionlint/cmd/actionlint

- name: Get golangci-lint cache dir

run: |

dir=$(golangci-lint cache status | awk '/Dir/ { print $2 }')

echo "LINT_CACHE_DIR=$dir" >> "$GITHUB_ENV"

# Cache split into restore + conditional save to avoid letting PR

# runs populate a cache that other branches restore from (the

# zizmor `cache-poisoning` concern). Only pushes to the default

# branch may write the cache; PRs may only read it.

- name: Restore golangci-lint cache

id: golangci-lint-cache

uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0

with:

path: |

${{ env.LINT_CACHE_DIR }}

key: golangci-lint-${{ runner.os }}-${{ hashFiles('**/*.go') }}

restore-keys: |

golangci-lint-${{ runner.os }}-

# Check for any typos

- name: Check for typos

run: typos --config .github/workflows/typos.toml

- name: Fix the typos

if: ${{ failure() }}

run: |

echo "::notice:: you can automatically fix typos from your CLI:

mise exec aqua:crate-ci/typos -- typos -c .github/workflows/typos.toml -w"

- name: Verify helm version

run: helm version --short

- name: Download Go modules

run: ./.github/scripts/retry.sh -- go mod download

- name: make lint

# Bound concurrent lint targets to keep peak memory below the runner limit.

run: make --output-sync=line -j"$(nproc)" lint

- name: Save golangci-lint cache

# Only the default branch is trusted to write the cache, so PR

# runs cannot poison the cache that subsequent runs restore from.

# Skip when the cache already had an exact key hit (no new content).

if: github.ref == 'refs/heads/main' && steps.golangci-lint-cache.outputs.cache-hit != 'true'

uses: actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0

with:

path: |

${{ env.LINT_CACHE_DIR }}

key: ${{ steps.golangci-lint-cache.outputs.cache-primary-key }}

- name: Check workflow files

run: actionlint -color -shellcheck= -ignore "set-output"

shell: bash

- name: Check for unstaged files

run: ./scripts/check_unstaged.sh

shell: bash

lint-actions:

needs: changes

# Only run this job if changes to CI workflow files are detected. This job

# can flake as it reaches out to GitHub to check referenced actions.

if: needs.changes.outputs.ci == 'true'

runs-on: ${{ github.repository_owner == 'coder' && 'depot-ubuntu-24.04-8' || 'ubuntu-24.04' }}

steps:

- name: Harden Runner

uses: step-security/harden-runner@05e31511f85b41b11d1cf0ef85d0992719546e2c # v2.21.0

with:

egress-policy: audit

- name: Checkout

uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

with:

fetch-depth: 1

persist-credentials: false

- name: Set up mise tools

uses: ./.github/actions/setup-mise

with:

install-args: "go zizmor"

- name: Install Go mise tools

run: ./.github/scripts/retry.sh -- mise install --locked go:github.com/rhysd/actionlint/cmd/actionlint

- name: make lint/actions

run: make --output-sync=line -j lint/actions

env:

# Used by zizmor to lint third-party GitHub actions.

GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

gen:

timeout-minutes: 20

runs-on: ${{ github.repository_owner == 'coder' && 'depot-ubuntu-22.04-8' || 'ubuntu-latest' }}

if: ${{ !cancelled() }}

steps:

- name: Harden Runner

uses: step-security/harden-runner@05e31511f85b41b11d1cf0ef85d0992719546e2c # v2.21.0

with:

egress-policy: audit

- name: Checkout

uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

with:

fetch-depth: 1

persist-credentials: false

- name: Set up mise tools

uses: ./.github/actions/setup-mise

with:

install-args: "go node pnpm terraform protoc protoc-gen-go"

- name: Install pnpm dependencies

uses: ./.github/actions/pnpm-install

- name: Install Go mise tools

run: ./.github/scripts/retry.sh -- mise install --locked go:storj.io/drpc/cmd/protoc-gen-go-drpc go:github.com/coder/sqlc/cmd/sqlc

- name: Start PostgreSQL container

run: make test-postgres-docker

- name: make gen

timeout-minutes: 8

run: |

# Remove golden files to detect discrepancy in generated files.

make clean/golden-files

# Notifications require DB, we could start a DB instance here but

# let's just restore for now.

git checkout -- coderd/notifications/testdata/rendered-templates

make -j --output-sync -B gen

- name: Check for unstaged files

run: ./scripts/check_unstaged.sh

- name: Collect PostgreSQL logs

if: always()

run: make test-postgres-docker-logs > postgres.log 2>&1

- name: Upload PostgreSQL logs

if: always()

uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1

with:

path: postgres.log

fmt:

needs: changes

if: needs.changes.outputs.offlinedocs-only == 'false' || needs.changes.outputs.ci == 'true' || github.ref == 'refs/heads/main'

runs-on: ${{ github.repository_owner == 'coder' && 'depot-ubuntu-22.04-8' || 'ubuntu-latest' }}

timeout-minutes: 20

steps:

- name: Harden Runner

uses: step-security/harden-runner@05e31511f85b41b11d1cf0ef85d0992719546e2c # v2.21.0

with:

egress-policy: audit

- name: Checkout

uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

with:

fetch-depth: 1

persist-credentials: false

- name: Check Go version

run: IGNORE_NIX=true ./scripts/check_go_versions.sh

- name: Set up mise tools

uses: ./.github/actions/setup-mise

with:

install-args: "go node pnpm terraform"

- name: Install pnpm dependencies

uses: ./.github/actions/pnpm-install

- name: Install Go mise tools

run: ./.github/scripts/retry.sh -- mise install --locked go:mvdan.cc/sh/v3/cmd/shfmt

- name: make fmt

timeout-minutes: 7

run: make --output-sync -j -B fmt

- name: Check for unstaged files

run: ./scripts/check_unstaged.sh

test-go-pg:

# make sure to adjust NUM_PARALLEL_PACKAGES and NUM_PARALLEL_TESTS below

# when changing runner sizes

runs-on: ${{ matrix.os == 'ubuntu-latest' && github.repository_owner == 'coder' && 'depot-ubuntu-22.04-8' || matrix.os && matrix.os == 'macos-latest' && github.repository_owner == 'coder' && 'depot-macos-latest' || matrix.os == 'windows-2022' && github.repository_owner == 'coder' && 'depot-windows-2022-16' || matrix.os }}

needs: changes

if: needs.changes.outputs.go == 'true' || needs.changes.outputs.ci == 'true' || github.ref == 'refs/heads/main'

# This timeout must be greater than the timeout set by `go test` in

# `make test` to ensure we receive a trace of running goroutines.

# Setting this to the timeout +5m should work quite well even if

# some of the preceding steps are slow.

timeout-minutes: 30

strategy:

fail-fast: false

matrix:

os:

- ubuntu-latest

- macos-latest

- windows-2022

steps:

- name: Harden Runner

uses: step-security/harden-runner@05e31511f85b41b11d1cf0ef85d0992719546e2c # v2.21.0

with:

egress-policy: audit

# macOS indexes all new files in the background. Our Postgres tests

# create and destroy thousands of databases on disk, and Spotlight

# tries to index all of them, seriously slowing down the tests.

- name: Disable Spotlight Indexing

if: runner.os == 'macOS'

run: |

enabled=$(sudo mdutil -a -s | { grep -Fc "Indexing enabled" || true; })

if [ "$enabled" -eq 0 ]; then

echo "Spotlight indexing is already disabled"

exit 0

sudo mdutil -a -i off

sudo mdutil -X /

sudo launchctl bootout system /System/Library/LaunchDaemons/com.apple.metadata.mds.plist

# Set up RAM disks to speed up the rest of the job. This action is in

# a separate repository to allow its use before actions/checkout.

- name: Setup RAM Disks

if: runner.os == 'Windows'

uses: coder/setup-ramdisk-action@e1100847ab2d7bcd9d14bcda8f2d1b0f07b36f1b # v0.1.0

- name: Checkout

uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

with:

fetch-depth: 1

persist-credentials: false

- name: Setup Go Paths

uses: ./.github/actions/setup-go-paths

- name: Setup GNU tools (macOS)

uses: ./.github/actions/setup-gnu-tools

- name: Set up mise tools

uses: ./.github/actions/setup-mise

with:

install-args: "go terraform"

- name: Install Go mise tools

shell: bash

run: ./.github/scripts/retry.sh -- mise install --locked go:gotest.tools/gotestsum go:github.com/slsyy/mtimehash/cmd/mtimehash

- name: Download Test Cache

id: download-cache

uses: ./.github/actions/test-cache/download

with:

key-prefix: test-go-pg-${{ runner.os }}-${{ runner.arch }}

- name: Setup Embedded Postgres Cache Paths

id: embedded-pg-cache

uses: ./.github/actions/setup-embedded-pg-cache-paths

- name: Download Embedded Postgres Cache

id: download-embedded-pg-cache

uses: ./.github/actions/embedded-pg-cache/download

with:

key-prefix: embedded-pg-${{ runner.os }}-${{ runner.arch }}

cache-path: ${{ steps.embedded-pg-cache.outputs.cached-dirs }}

- name: Normalize File and Directory Timestamps

shell: bash

# Normalize file modification timestamps so that go test can use the

# cache from the previous CI run. See https://github.com/golang/go/issues/58571

# for more details.

# mtimehash only optimizes cache hits, so a missing binary must not

# fail the job before any tests run (coder/internal#1630).

run: |

if command -v mtimehash >/dev/null 2>&1; then

find . -type f ! -path ./.git/\*\* | mtimehash

else

echo "::warning::mtimehash not found; skipping file timestamp normalization (Go test cache may be cold)"

find . -type d ! -path ./.git/\*\* -exec touch -t 200601010000 {} +

- name: Normalize Terraform Path for Caching

shell: bash

# Terraform gets installed in a random directory, so we need to normalize

# the path or many cached tests will be invalidated.

run: |

mkdir -p "$RUNNER_TEMP/sym"

source scripts/normalize_path.sh

normalize_path_with_symlinks "$RUNNER_TEMP/sym" "$(dirname "$(which terraform)")"

- name: Setup RAM disk for Embedded Postgres (Windows)

if: runner.os == 'Windows'

shell: bash

# The default C: drive is extremely slow:

# https://github.com/actions/runner-images/issues/8755

run: mkdir -p "R:/temp/embedded-pg"

- name: Setup RAM disk for Embedded Postgres (macOS)

if: runner.os == 'macOS'

shell: bash

run: |

# Postgres runs faster on a ramdisk on macOS.

mkdir -p /tmp/tmpfs

sudo mount_tmpfs -o noowners -s 8g /tmp/tmpfs

# macOS will output "The default interactive shell is now zsh" intermittently in CI.

touch ~/.bash_profile && echo "export BASH_SILENCE_DEPRECATION_WARNING=1" >> ~/.bash_profile

- name: Increase PTY limit (macOS)

if: runner.os == 'macOS'

shell: bash

run: |

# Increase PTY limit to avoid exhaustion during tests.

# Default is 511; 999 is the maximum value on CI runner.

sudo sysctl -w kern.tty.ptmx_max=999

- name: Test with PostgreSQL Database (Linux)

if: runner.os == 'Linux'

uses: ./.github/actions/test-go-pg

with:

postgres-version: "13"

# Our Linux runners have 8 cores.

test-parallelism-packages: "8"

test-parallelism-tests: "8"

# By default, run tests with cache for improved speed (possibly at the expense of correctness).

# On main, run tests without cache for the inverse.

test-count: ${{ github.ref == 'refs/heads/main' && '1' || '' }}

gotestsum-json-file: default

- name: Test with PostgreSQL Database (macOS)

if: runner.os == 'macOS'

uses: ./.github/actions/test-go-pg

with:

postgres-version: "13"

# Our macOS runners have 8 cores. test-parallelism-tests matches

# Linux's rather than the previous 16, to rule out scheduler

# contention as a contributor to the macOS test-go-pg timeouts

# tracked in coder/internal#1365.

test-parallelism-packages: "8"

test-parallelism-tests: "8"

# By default, run tests with cache for improved speed (possibly at the expense of correctness).

# On main, run tests without cache for the inverse.

test-count: ${{ github.ref == 'refs/heads/main' && '1' || '' }}

# Only the CLI and Agent are officially supported on macOS; the rest are too flaky.

test-packages: "./cli/... ./enterprise/cli/... ./agent/..."

embedded-pg-path: "/tmp/tmpfs/embedded-pg"

embedded-pg-cache: ${{ steps.embedded-pg-cache.outputs.embedded-pg-cache }}

- name: Test with PostgreSQL Database (Windows)

if: runner.os == 'Windows'

uses: ./.github/actions/test-go-pg

with:

postgres-version: "13"

# Our Windows runners have 16 cores.

# On Windows Postgres chokes up when we have 16x16=256 tests

# running in parallel, and dbtestutil.NewDB starts to take more than

# 10s to complete sometimes causing test timeouts. With 16x8=128 tests

# Postgres tends not to choke.

test-parallelism-packages: "8"

test-parallelism-tests: "16"

# By default, run tests with cache for improved speed (possibly at the expense of correctness).

# On main, run tests without cache for the inverse.

test-count: ${{ github.ref == 'refs/heads/main' && '1' || '' }}

# Only the CLI and Agent are officially supported on Windows; the rest are too flaky.

test-packages: "./cli/... ./enterprise/cli/... ./agent/..."

embedded-pg-path: "R:/temp/embedded-pg"

embedded-pg-cache: ${{ steps.embedded-pg-cache.outputs.embedded-pg-cache }}

- name: Publish Go test failure report

if: failure() && github.actor != 'dependabot[bot]' && runner.os == 'Linux' && (github.event_name != 'pull_request' || !github.event.pull_request.head.repo.fork)

uses: ./.github/actions/go-test-failure-report

with:

artifact-name: go-test-failures-${{ github.job }}-${{ github.sha }}

- name: Upload failed test db dumps

uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1

with:

path: "**/*.test.sql"

- name: Upload Test Cache

uses: ./.github/actions/test-cache/upload

with:

cache-key: ${{ steps.download-cache.outputs.cache-key }}

- name: Upload Embedded Postgres Cache

uses: ./.github/actions/embedded-pg-cache/upload

# We only use the embedded Postgres cache on macOS and Windows runners.

if: runner.OS == 'macOS' || runner.OS == 'Windows'

with:

cache-key: ${{ steps.download-embedded-pg-cache.outputs.cache-key }}

cache-path: "${{ steps.embedded-pg-cache.outputs.embedded-pg-cache }}"

- name: Upload test stats to Datadog

timeout-minutes: 1

continue-on-error: true

uses: ./.github/actions/upload-datadog

if: success() || failure()

with:

api-key: ${{ secrets.DATADOG_API_KEY }}

test-go-pg-17:

runs-on: ${{ github.repository_owner == 'coder' && 'depot-ubuntu-22.04-8' || 'ubuntu-latest' }}

needs:

- changes

if: needs.changes.outputs.go == 'true' || needs.changes.outputs.ci == 'true' || github.ref == 'refs/heads/main'

# This timeout must be greater than the timeout set by `go test` in

# `make test` to ensure we receive a trace of running goroutines.

# Setting this to the timeout +5m should work quite well even if

# some of the preceding steps are slow.

timeout-minutes: 30

steps:

- name: Harden Runner

uses: step-security/harden-runner@05e31511f85b41b11d1cf0ef85d0992719546e2c # v2.21.0

with:

egress-policy: audit

- name: Checkout

uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

with:

fetch-depth: 1

persist-credentials: false

- name: Set up mise tools

uses: ./.github/actions/setup-mise

with:

install-args: "go terraform"

- name: Install Go mise tools

run: ./.github/scripts/retry.sh -- mise install --locked go:gotest.tools/gotestsum

- name: Download Test Cache

id: download-cache

uses: ./.github/actions/test-cache/download

with:

key-prefix: test-go-pg-17-${{ runner.os }}-${{ runner.arch }}

- name: Normalize Terraform Path for Caching

shell: bash

# Terraform gets installed in a random directory, so we need to normalize

# the path or many cached tests will be invalidated.

run: |

mkdir -p "$RUNNER_TEMP/sym"

source scripts/normalize_path.sh

normalize_path_with_symlinks "$RUNNER_TEMP/sym" "$(dirname "$(which terraform)")"

- name: Test with PostgreSQL Database

uses: ./.github/actions/test-go-pg

with:

postgres-version: "17"

# Our Linux runners have 8 cores.

test-parallelism-packages: "8"

test-parallelism-tests: "8"

# By default, run tests with cache for improved speed (possibly at the expense of correctness).

# On main, run tests without cache for the inverse.

test-count: ${{ github.ref == 'refs/heads/main' && '1' || '' }}

gotestsum-json-file: default

- name: Publish Go test failure report

if: failure() && github.actor != 'dependabot[bot]' && runner.os == 'Linux' && (github.event_name != 'pull_request' || !github.event.pull_request.head.repo.fork)

uses: ./.github/actions/go-test-failure-report

with:

artifact-name: go-test-failures-${{ github.job }}-${{ github.sha }}

- name: Upload Test Cache

uses: ./.github/actions/test-cache/upload

with:

cache-key: ${{ steps.download-cache.outputs.cache-key }}

- name: Upload test stats to Datadog

timeout-minutes: 1

continue-on-error: true

uses: ./.github/actions/upload-datadog

if: success() || failure()

with:

api-key: ${{ secrets.DATADOG_API_KEY }}

test-go-race-pg:

runs-on: ${{ github.repository_owner == 'coder' && 'depot-ubuntu-22.04-16' || 'ubuntu-latest' }}

needs: changes

if: needs.changes.outputs.go == 'true' || needs.changes.outputs.ci == 'true' || github.ref == 'refs/heads/main'

# This timeout must be greater than the timeout set by `go test` in

# `make test-race` to ensure we receive a trace of running goroutines.

# Setting this to the timeout +5m should work quite well even if

# some of the preceding steps are slow.

timeout-minutes: 30

steps:

- name: Harden Runner

uses: step-security/harden-runner@05e31511f85b41b11d1cf0ef85d0992719546e2c # v2.21.0

with:

egress-policy: audit

- name: Checkout

uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

with:

fetch-depth: 1

persist-credentials: false

- name: Set up mise tools

uses: ./.github/actions/setup-mise

with:

install-args: "go terraform"

- name: Install Go mise tools

run: ./.github/scripts/retry.sh -- mise install --locked go:gotest.tools/gotestsum

- name: Download Test Cache

id: download-cache

uses: ./.github/actions/test-cache/download

with:

key-prefix: test-go-race-pg-${{ runner.os }}-${{ runner.arch }}

- name: Normalize Terraform Path for Caching

shell: bash

# Terraform gets installed in a random directory, so we need to normalize

# the path or many cached tests will be invalidated.

run: |

mkdir -p "$RUNNER_TEMP/sym"

source scripts/normalize_path.sh

normalize_path_with_symlinks "$RUNNER_TEMP/sym" "$(dirname "$(which terraform)")"

# We run race tests with reduced parallelism because they use more CPU and we were finding

# instances where tests appear to hang for multiple seconds, resulting in flaky tests when

# short timeouts are used.

# c.f. discussion on https://github.com/coder/coder/pull/15106

# Our Linux runners have 16 cores, but we reduce parallelism since race detection adds a lot of overhead.

# We aim to have parallelism match CPU count (4*4=16) to avoid making flakes worse.

- name: Run Tests

uses: ./.github/actions/test-go-pg

with:

postgres-version: "17"

test-parallelism-packages: "4"

test-parallelism-tests: "4"

race-detection: "true"

gotestsum-json-file: default

- name: Publish Go test failure report

if: failure() && github.actor != 'dependabot[bot]' && runner.os == 'Linux' && (github.event_name != 'pull_request' || !github.event.pull_request.head.repo.fork)

uses: ./.github/actions/go-test-failure-report

with:

artifact-name: go-test-failures-${{ github.job }}-${{ github.sha }}

- name: Upload Test Cache

uses: ./.github/actions/test-cache/upload

with:

cache-key: ${{ steps.download-cache.outputs.cache-key }}

- name: Upload test stats to Datadog

timeout-minutes: 1

continue-on-error: true

uses: ./.github/actions/upload-datadog

if: always()

with:

api-key: ${{ secrets.DATADOG_API_KEY }}

# Tailnet integration tests only run when the `tailnet` directory or `go.sum`

# and `go.mod` are changed. These tests are to ensure we don't add regressions

# to tailnet, either due to our code or due to updating dependencies.

# These tests are skipped in the main go test jobs because they require root

# and mess with networking.

test-go-tailnet-integration:

runs-on: ${{ github.repository_owner == 'coder' && 'depot-ubuntu-22.04-8' || 'ubuntu-latest' }}

needs: changes

# Unnecessary to run on main for now

if: needs.changes.outputs.tailnet-integration == 'true' || needs.changes.outputs.ci == 'true'

timeout-minutes: 20

steps:

- name: Harden Runner

uses: step-security/harden-runner@05e31511f85b41b11d1cf0ef85d0992719546e2c # v2.21.0

with:

egress-policy: audit

- name: Checkout

uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

with:

fetch-depth: 1

persist-credentials: false

- name: Set up mise tools

uses: ./.github/actions/setup-mise

with:

install-args: "go"

# Used by some integration tests.

- name: Install Nginx

run: sudo apt-get update && sudo apt-get install -y nginx

- name: Run Tests

run: make test-tailnet-integration

test-js:

runs-on: ${{ github.repository_owner == 'coder' && 'depot-ubuntu-22.04-8' || 'ubuntu-latest' }}

needs: changes

if: needs.changes.outputs.site == 'true' || needs.changes.outputs.ci == 'true' || github.ref == 'refs/heads/main'

timeout-minutes: 20

steps:

- name: Harden Runner

uses: step-security/harden-runner@05e31511f85b41b11d1cf0ef85d0992719546e2c # v2.21.0

with:

egress-policy: audit

- name: Checkout

uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

with:

fetch-depth: 1

persist-credentials: false

- name: Set up mise tools

uses: ./.github/actions/setup-mise

with:

install-args: "node pnpm"

- name: Install pnpm dependencies

uses: ./.github/actions/pnpm-install

- run: pnpm test:ci --max-workers "$(nproc)"

working-directory: site

test-e2e:

runs-on: ${{ github.repository_owner == 'coder' && 'depot-ubuntu-22.04-4' || 'ubuntu-latest' }}

needs: changes

strategy:

fail-fast: false

matrix:

variant:

- premium: false

#- premium: true

# name: test-e2e-premium

# Skip test-e2e on forks as they don't have access to CI secrets

if: (needs.changes.outputs.go == 'true' || needs.changes.outputs.site == 'true' || needs.changes.outputs.ci == 'true' || github.ref == 'refs/heads/main') && !(github.event.pull_request.head.repo.fork)

timeout-minutes: 20

steps:

- name: Harden Runner

uses: step-security/harden-runner@05e31511f85b41b11d1cf0ef85d0992719546e2c # v2.21.0

with:

egress-policy: audit

- name: Checkout

uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

with:

fetch-depth: 1

persist-credentials: false

- name: Set up mise tools

uses: ./.github/actions/setup-mise

with:

install-args: "go node pnpm"

- name: Install pnpm dependencies

uses: ./.github/actions/pnpm-install

# Assume that the checked-in versions are up-to-date

- run: make gen/mark-fresh

- run: pnpm build

env:

NODE_OPTIONS: ${{ github.repository_owner == 'coder' && '--max_old_space_size=8192' || '' }}

working-directory: site

View remainder of file in raw view

coder/.github/workflows/ci.yaml at main · coder/coder · GitHub

Uh oh!

Expand file tree

Breadcrumbs

ci.yaml

Latest commit

History

Breadcrumbs

ci.yaml

File metadata and controls