Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 83 additions & 0 deletions .github/workflows/preview-packages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
name: 📦 Preview packages (pkg.pr.new)

# Publishes installable preview builds of the public @trigger.dev/* packages
# for every push to a branch, via https://pkg.pr.new. These are NOT published
# to npm — pkg.pr.new serves them by commit SHA and drops install instructions
# in a comment on the associated PR, e.g.
# npm i https://pkg.pr.new/@trigger.dev/sdk@<sha>
#
# Prerequisites:
# - The pkg.pr.new GitHub App must be installed on triggerdotdev/trigger.dev
# (https://github.com/apps/pkg-pr-new). Publishing fails until it is.
#
# Fork note: pkg.pr.new authenticates with a GitHub Actions OIDC token, which
# GitHub does not issue to pull_request workflows from forks. This `push`
# trigger therefore covers branches pushed to this repo (the core team), not
# external fork PRs. Adding fork coverage would require a workflow_run two-stage
# setup.

on:
push:
branches-ignore:
- main
- changeset-release/main
paths:
- "package.json"
- "packages/**"
- "pnpm-lock.yaml"
- "pnpm-workspace.yaml"
- "turbo.json"
- ".github/workflows/preview-packages.yml"
- "scripts/stamp-preview-version.mjs"
Comment thread
coderabbitai[bot] marked this conversation as resolved.
- "scripts/updateVersion.ts"

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

permissions:
contents: read
id-token: write # OIDC token used by pkg.pr.new to authenticate the publish

jobs:
publish:
name: Build and publish previews
runs-on: ubuntu-latest
if: github.repository == 'triggerdotdev/trigger.dev'
steps:
- name: ⬇️ Checkout repo
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
fetch-depth: 0
persist-credentials: false

- name: ⎔ Setup pnpm
uses: pnpm/action-setup@fc06bc1257f339d1d5d8b3a19a8cae5388b55320 # v5.0.0
with:
version: 10.33.2

- name: ⎔ Setup node
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
with:
node-version: 20.20.0
cache: "pnpm"

- name: 📥 Install dependencies
run: pnpm install --frozen-lockfile

- name: 📀 Generate Prisma client
run: pnpm run generate

# Stamp a unique 0.0.0-preview-<sha> version before building so it can't
# collide with real npm versions and so updateVersion.ts bakes it into the
# runtime VERSION constant. See scripts/stamp-preview-version.mjs.
- name: 🏷️ Stamp preview version
run: node scripts/stamp-preview-version.mjs
env:
GITHUB_SHA: ${{ github.sha }}

- name: 🔨 Build packages
run: pnpm run build --filter "@trigger.dev/*" --filter "trigger.dev"

- name: 🚀 Publish previews to pkg.pr.new
run: pnpm exec pkg-pr-new publish --pnpm --compact --commentWithSha './packages/*'
Comment thread
ericallam marked this conversation as resolved.
Comment thread
ericallam marked this conversation as resolved.
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@
"autoprefixer": "^10.4.12",
"eslint-plugin-turbo": "^2.0.4",
"lefthook": "^1.11.3",
"pkg-pr-new": "0.0.75",
"pkg-types": "1.1.3",
"prettier": "^3.0.0",
"tsx": "^3.7.1",
Expand Down
9 changes: 9 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

92 changes: 92 additions & 0 deletions scripts/stamp-preview-version.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
// Rewrites the version of every public packages/* package to a unique,
// preview-only semver (0.0.0-preview-<sha>) BEFORE the build runs.
//
// Why this exists:
// pkg.pr.new serves preview builds by commit SHA but does NOT change the
// package.json "version" field (as of 0.0.75). If a preview is published
// while package.json still says e.g. 4.5.0-rc.4, a consumer who installs the
// preview pins 4.5.0-rc.4 to the pkg.pr.new tarball in their lockfile/cache,
// and a later `npm i @trigger.dev/sdk@4.5.0-rc.4` from npm can resolve to the
// stale preview. See stackblitz-labs/pkg.pr.new#250 and #390.
//
// A 0.0.0- prefix can never satisfy a real semver range, so the collision
// becomes structurally impossible (the same convention React/Next canaries
// use).
//
// Running BEFORE the build also means scripts/updateVersion.ts bakes this
// same preview version into the runtime VERSION constant, so previews are
// self-identifying (trigger --version, the x-trigger-cli-version header, the
// MCP server version, etc.) rather than all reporting the RC version.
//
// Sibling workspace: specifiers are relaxed to workspace:* so `pnpm pack`
// resolves them against the rewritten versions without range-validation
// errors. packages/python pins peerDependencies as workspace:^4.5.0-rc.4,
// which would otherwise be unsatisfiable once the sibling version changes.
//
// Note: pkg.pr.new PR #525 adds a built-in --previewVersion flag. Once that
// ships we could drop the version-rewrite half here, but we still want a
// pre-build stamp so updateVersion.ts picks up the preview version (the flag
// rewrites at pack time, which is too late for the baked VERSION constant).

import { readdirSync, readFileSync, writeFileSync, existsSync } from "node:fs";
import { join } from "node:path";
import { execSync } from "node:child_process";

const PACKAGES_DIR = "packages";
const DEP_SECTIONS = [
"dependencies",
"devDependencies",
"peerDependencies",
"optionalDependencies",
];

function resolveSha() {
const sha = process.argv[2] || process.env.GITHUB_SHA;
if (sha) return sha;
try {
return execSync("git rev-parse HEAD", { encoding: "utf8" }).trim();
} catch {
throw new Error(
"Could not determine commit SHA (pass as the first argument or set GITHUB_SHA)"
);
}
}

const sha = resolveSha().slice(0, 7);
const previewVersion = `0.0.0-preview-${sha}`;

const dirs = readdirSync(PACKAGES_DIR, { withFileTypes: true }).filter((e) =>
e.isDirectory()
);

// First pass: collect every public package name so we know which workspace
// specifiers point at a sibling whose version we are about to change.
const publicNames = new Set();
const manifests = [];
for (const dir of dirs) {
const pkgPath = join(PACKAGES_DIR, dir.name, "package.json");
if (!existsSync(pkgPath)) continue;
const json = JSON.parse(readFileSync(pkgPath, "utf8"));
manifests.push({ pkgPath, json });
if (!json.private && json.name) publicNames.add(json.name);
}

// Second pass: stamp the version and relax sibling workspace specifiers.
let stamped = 0;
for (const { pkgPath, json } of manifests) {
if (json.private) continue;
json.version = previewVersion;
for (const section of DEP_SECTIONS) {
const deps = json[section];
if (!deps) continue;
for (const [name, spec] of Object.entries(deps)) {
if (publicNames.has(name) && String(spec).startsWith("workspace:")) {
deps[name] = "workspace:*";
}
}
}
writeFileSync(pkgPath, `${JSON.stringify(json, null, 2)}\n`);
stamped++;
}

console.log(`Stamped ${stamped} public package(s) to ${previewVersion}`);
Loading