Skip to content

fix(wrangler): skip banner when using --json flag in wrangler pages deployment commands #10822

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

Merged
edmundhung merged 2 commits into from
Oct 1, 2025
Merged

fix(wrangler): skip banner when using --json flag in wrangler pages deployment commands #10822

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
707193a
fix(wrangler): wrangler pages deployment list --json should skip the …
edmundhung Sep 30, 2025
f2dd2be
refactor(wrangler): align printBanner setup on wrangler deployment co…
edmundhung Sep 30, 2025
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 .changeset/bumpy-schools-sniff.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"wrangler": patch
---

fix: skip banner when using `--json` flag in `wrangler pages deployment` commands
6 changes: 5 additions & 1 deletion packages/wrangler/src/__tests__/pages/deployment-list.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import { runWrangler } from "./../helpers/run-wrangler";
import type { Deployment } from "./../../pages/types";

describe("pages deployment list", () => {
vi.unmock("../../wrangler-banner");

@petebacondarwin petebacondarwin Oct 1, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we should unmock print banner across all the tests?

@edmundhung edmundhung Oct 1, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. That's my plan next after all these PRs. It's really tricky to catch this when we have it mocked by default, especially when the command is done by external team.

But it would probably be a huge PR as it will likely impact a fair amount of snapshots test we had.

runInTempDir();
mockAccountId();
mockApiToken();
Expand Down Expand Up @@ -47,7 +48,10 @@ describe("pages deployment list", () => {

expect(requests.count).toBe(1);
expect(std.out).toMatchInlineSnapshot(`
"┌─┬─┬─┬─┬─┬─┬─┐
"
⛅️ wrangler x.x.x
──────────────────
┌─┬─┬─┬─┬─┬─┬─┐
│ Id │ Environment │ Branch │ Source │ Deployment │ Status │ Build │
├─┼─┼─┼─┼─┼─┼─┤
│ 87bbc8fe-16be-45cd-81e0-63d722e82cdf │ Preview │ main │ c764936 │ https://87bbc8fe.images.pages.dev │ 3 years ago │ https://dash.cloudflare.com/some-account-id/pages/view/images/87bbc8fe-16be-45cd-81e0-63d722e82cdf │
Expand Down
1 change: 1 addition & 0 deletions packages/wrangler/src/pages/deployments.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ export const pagesDeploymentListCommand = createCommand({
},
behaviour: {
provideConfig: false,
printBanner: (args) => !args.json,
},
args: {
"project-name": {
Expand Down
2 changes: 1 addition & 1 deletion packages/wrangler/src/versions/deployments/list.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export const deploymentsListCommand = createCommand({
},
},
behaviour: {
printBanner: false,
printBanner: (args) => !args.json,
},
handler: async function versionsDeploymentsListHandler(args, { config }) {
metrics.sendMetricsEvent(
Expand Down
7 changes: 1 addition & 6 deletions packages/wrangler/src/versions/deployments/status.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ import { UserError } from "../../errors";
import * as metrics from "../../metrics";
import { requireAuth } from "../../user";
import formatLabelledValues from "../../utils/render-labelled-values";
import { printWranglerBanner } from "../../wrangler-banner";
import { fetchLatestDeployment, fetchVersions } from "../api";
import { getDeploymentSource } from "./list";
import type { VersionCache } from "../types";
Expand All @@ -32,13 +31,9 @@ export const deploymentsStatusCommand = createCommand({
},
},
behaviour: {
printBanner: false,
printBanner: (args) => !args.json,
},
handler: async function versionsDeploymentsStatusHandler(args, { config }) {
if (!args.json) {
await printWranglerBanner();
}

metrics.sendMetricsEvent(
"view latest versioned deployment",
{},
Expand Down
Loading