Skip to content

Commit c6a39f5

Browse files
authored
fix versions upload positional arg (#10515)
* set script as a positional arg * move args around so it presents better in the docs
1 parent c22acc6 commit c6a39f5

File tree

4 files changed

+53
-22
lines changed

4 files changed

+53
-22
lines changed

.changeset/three-toys-feel.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"wrangler": patch
3+
---
4+
5+
fix: script should be accepted as a positional arg in the `versions upload` command

packages/wrangler/src/__tests__/versions/versions.help.test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ describe("versions --help", () => {
1818
COMMANDS
1919
wrangler versions view <version-id> View the details of a specific version of your Worker
2020
wrangler versions list List the 10 most recent Versions of your Worker
21-
wrangler versions upload Uploads your Worker code and config as a new Version
21+
wrangler versions upload [script] Uploads your Worker code and config as a new Version
2222
wrangler versions deploy [version-specs..] Safely roll out new Versions of your Worker by splitting traffic between multiple Versions
2323
wrangler versions secret Generate a secret that can be referenced in a Worker
2424
@@ -50,7 +50,7 @@ describe("versions subhelp", () => {
5050
COMMANDS
5151
wrangler versions view <version-id> View the details of a specific version of your Worker
5252
wrangler versions list List the 10 most recent Versions of your Worker
53-
wrangler versions upload Uploads your Worker code and config as a new Version
53+
wrangler versions upload [script] Uploads your Worker code and config as a new Version
5454
wrangler versions deploy [version-specs..] Safely roll out new Versions of your Worker by splitting traffic between multiple Versions
5555
wrangler versions secret Generate a secret that can be referenced in a Worker
5656

packages/wrangler/src/__tests__/versions/versions.upload.test.ts

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,31 @@ describe("versions upload", () => {
122122
`);
123123
});
124124

125+
test("should accept script as a positional arg", async () => {
126+
mockGetScript();
127+
mockUploadVersion(false);
128+
129+
// Setup
130+
writeWranglerConfig({
131+
name: "test-name",
132+
// i.e. would error if the arg wasn't picked up
133+
main: "./nope.js",
134+
});
135+
writeWorkerSource();
136+
setIsTTY(false);
137+
138+
const result = runWrangler("versions upload index.js");
139+
140+
await expect(result).resolves.toBeUndefined();
141+
142+
expect(std.out).toMatchInlineSnapshot(`
143+
"Total Upload: xx KiB / gzip: xx KiB
144+
Worker Startup Time: 500 ms
145+
Uploaded test-name (TIMINGS)
146+
Worker Version ID: 51e4886e-2db7-4900-8d38-fbfecfeab993"
147+
`);
148+
});
149+
125150
test("should print preview url if version has preview", async () => {
126151
mockGetScript();
127152
mockUploadVersion(true);

packages/wrangler/src/versions/upload.ts

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -104,24 +104,41 @@ export const versionsUploadCommand = createCommand({
104104
owner: "Workers: Authoring and Testing",
105105
status: "stable",
106106
},
107+
positionalArgs: ["script"],
107108
args: {
108109
script: {
109110
describe: "The path to an entry point for your Worker",
110111
type: "string",
111112
requiresArg: true,
112113
},
113114
name: {
114-
describe: "Name of the worker",
115+
describe: "Name of the Worker",
116+
type: "string",
117+
requiresArg: true,
118+
},
119+
tag: {
120+
describe: "A tag for this Worker Gradual Rollouts Version",
121+
type: "string",
122+
requiresArg: true,
123+
},
124+
message: {
125+
describe:
126+
"A descriptive message for this Worker Gradual Rollouts Version",
127+
type: "string",
128+
requiresArg: true,
129+
},
130+
"preview-alias": {
131+
describe: "Name of an alias for this Worker version",
115132
type: "string",
116133
requiresArg: true,
117134
},
118135
bundle: {
119-
describe: "Run wrangler's compilation step before publishing",
136+
describe: "Run Wrangler's compilation step before publishing",
120137
type: "boolean",
121138
hidden: true,
122139
},
123140
"no-bundle": {
124-
describe: "Skip internal build steps and directly deploy Worker",
141+
describe: "Skip internal build steps and directly upload Worker",
125142
type: "boolean",
126143
default: false,
127144
},
@@ -231,25 +248,9 @@ export const versionsUploadCommand = createCommand({
231248
deprecated: true,
232249
},
233250
"dry-run": {
234-
describe: "Don't actually deploy",
251+
describe: "Compile a project without actually uploading the version.",
235252
type: "boolean",
236253
},
237-
tag: {
238-
describe: "A tag for this Worker Gradual Rollouts Version",
239-
type: "string",
240-
requiresArg: true,
241-
},
242-
message: {
243-
describe:
244-
"A descriptive message for this Worker Gradual Rollouts Version",
245-
type: "string",
246-
requiresArg: true,
247-
},
248-
"preview-alias": {
249-
describe: "Name of an alias for this Worker version",
250-
type: "string",
251-
requiresArg: true,
252-
},
253254
"experimental-auto-create": {
254255
describe: "Automatically provision draft bindings with new resources",
255256
type: "boolean",

0 commit comments

Comments
 (0)