Skip to content

feat(cloudflare): support wrangler preview command in varlock-wrangler #1018

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
theoephraim wants to merge 3 commits into
base: main
Choose a base branch
from
Open

feat(cloudflare): support wrangler preview command in varlock-wrangler #1018

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5792ed9
feat(cloudflare): support new wrangler preview command in varlock-wra…
theoephraim Aug 18, 2026
b3619a2
docs: note wrangler preview is in beta
theoephraim Aug 18, 2026
c604f56
fix cloudflare preview command routing
pullfrog[bot] Aug 18, 2026
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
5 changes: 5 additions & 0 deletions .bumpy/wrangler-preview-command.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@varlock/cloudflare-integration": minor
---

varlock-wrangler now supports the new `wrangler preview` command, uploading resolved vars and secrets to branch preview deployments
6 changes: 5 additions & 1 deletion packages/integrations/cloudflare/src/varlock-wrangler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import { spawn, execSync } from 'node:child_process';
import { execSyncVarlock, VarlockExecError } from 'varlock/exec-sync-varlock';
import { encryptEnvBlobSync, generateEncryptionKeyHex } from 'varlock/encrypt-env';
import { formatEnvLine } from './format-env-line';
import { isPreviewDeployCommand } from './wrangler-command-detection';

const isWindows = process.platform === 'win32';
const debugEnabled = !!process.env.VARLOCK_DEBUG;
Expand Down Expand Up @@ -355,6 +356,7 @@ function isVersionsUploadCommand(args: Array<string>) {
function isDeployCommand(args: Array<string>) {
if (args[0] === 'deploy') return true;
if (isVersionsUploadCommand(args)) return true;
if (isPreviewDeployCommand(args)) return true;
return false;
}

Expand Down Expand Up @@ -444,7 +446,8 @@ async function handleDeploy(args: Array<string>) {
try {
debug('deploy: spawning wrangler');
const wranglerArgs = [...args, ...varFlags, '--secrets-file', tmp.filePath];
if (!isVersionsUploadCommand(args)) wranglerArgs.push('--keep-vars=false');
// --keep-vars only applies to `deploy` (not `versions upload` or `preview`)
if (args[0] === 'deploy') wranglerArgs.push('--keep-vars=false');
exitCode = await spawnWrangler(wranglerArgs);
debug('deploy: wrangler exited with code', exitCode);
} finally {
Expand Down Expand Up @@ -751,6 +754,7 @@ async function main() {
console.log('Enhanced commands:');
console.log(' dev - injects resolved env via named pipe (no secrets on disk)');
console.log(' deploy / versions upload - uploads env as Cloudflare vars and secrets');
console.log(' preview - deploys a branch preview with env as vars and secrets');
console.log(' types - generates types including varlock-managed env vars');
console.log('');
console.log('All other commands are passed through to wrangler unchanged.');
Expand Down
28 changes: 28 additions & 0 deletions packages/integrations/cloudflare/src/wrangler-command-detection.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
const PREVIEW_SUBCOMMANDS = ['delete', 'settings', 'secret', 'base-config'];

const GLOBAL_OPTIONS_WITH_VALUES = [
'--config',
'-c',
'--cwd',
'--env',
'-e',
'--env-file',
'--profile',
];

export function isPreviewDeployCommand(args: Array<string>) {
if (args[0] !== 'preview' || args.includes('--help') || args.includes('-h')) return false;

for (let i = 1; i < args.length; i++) {
const arg = args[i];
if (arg === '--') return true;
if (GLOBAL_OPTIONS_WITH_VALUES.includes(arg)) {
i++;
continue;
}
if (arg.startsWith('-')) continue;
return !PREVIEW_SUBCOMMANDS.includes(arg);
}

return true;
}
26 changes: 26 additions & 0 deletions packages/integrations/cloudflare/test/wrangler-command-detection.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
import {
describe, expect, it,
} from 'vitest';
import { isPreviewDeployCommand } from '../src/wrangler-command-detection';

describe('isPreviewDeployCommand', () => {
it.each([
['preview', '--help'],
['preview', '-h'],
['preview', '--config', 'wrangler.jsonc', 'settings', '--help'],
['preview', '--config=wrangler.jsonc', 'delete'],
['preview', '-c', 'wrangler.jsonc', 'secret', 'list'],
['preview', '--env', 'staging', 'base-config', 'secret', 'list'],
])('passes through non-deploying invocation %j', (...args) => {
expect(isPreviewDeployCommand(args)).toBe(false);
});

it.each([
['preview'],
['preview', 'src/index.ts'],
['preview', '--config', 'wrangler.jsonc'],
['preview', '--config=wrangler.jsonc', 'src/index.ts'],
])('routes deployment invocation %j through varlock', (...args) => {
expect(isPreviewDeployCommand(args)).toBe(true);
});
});
4 changes: 3 additions & 1 deletion packages/varlock-website/src/content/docs/integrations/cloudflare.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,10 +204,12 @@ Wraps `wrangler dev` with automatic env injection. Resolves your environment var
</div>

<div>
### `varlock-wrangler deploy` / `versions upload`
### `varlock-wrangler deploy` / `versions upload` / `preview`

Resolves your environment variables from `.env.schema` + `.env` files, then uploads non-sensitive values as Cloudflare vars (`--var`), sensitive values as Cloudflare secrets (`--secrets-file`), and includes a `__VARLOCK_ENV` secret containing the full resolved env graph for the varlock runtime.

`varlock-wrangler preview` works the same way for [branch preview deployments](https://developers.cloudflare.com/workers/configuration/previews/). Note that `wrangler preview` is currently in beta on Cloudflare's side. Subcommands that manage existing previews (`preview delete`, `preview settings`, `preview secret`, `preview base-config`) are passed through to wrangler unchanged.

:::note[Secure secret handling]
On Unix, secrets are passed to wrangler commands via a named pipe (FIFO) and never written to disk. On Windows, a temporary file is used and immediately deleted after the deploy completes.
:::
Expand Down
Loading