Skip to content

Commit 24176f0

Browse files
Fix submission update docs for MS Store Dev CLI, add missing MSIX command (fixes #5294) (#6676)
* Fix submission update docs and add missing MSIX command (#5294) commands-exe.md: Add a TIP to the 'submission update' section explaining the get-then-update workflow. Developers were passing incomplete or incorrectly structured JSON because the docs gave no example. Added a PowerShell example that mirrors the pattern shown in github-actions.md. commands.md (MSIX): Add the missing 'submission update' command entry. It was listed in overview.md but completely absent from the commands table and body — a clear gap that would leave MSIX CLI users stuck. Fixes: MicrosoftDocs/windows-dev-docs-pr#5294 Co-authored-by: Copilot <[email protected]> * Fix Out-File encoding: add -Encoding utf8 to PowerShell examples Windows PowerShell defaults to UTF-16 for Out-File, which can cause interoperability issues when the JSON is processed by other tools. Explicit -Encoding utf8 ensures the saved file is UTF-8 compatible. Co-authored-by: Copilot <[email protected]> --------- Co-authored-by: Copilot <[email protected]>
1 parent b953177 commit 24176f0

2 files changed

Lines changed: 54 additions & 0 deletions

File tree

hub/apps/publish/msstore-dev-cli/commands-exe.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -275,6 +275,22 @@ msstore submission update <productId> <package>
275275
| -v, --verbose | Print verbose output. |
276276
| -?, -h, --help | Show help and usage information. |
277277

278+
> [!TIP]
279+
> Use `submission get` to retrieve the current package JSON before calling `submission update`. This ensures you're working with the correct structure and current values. For example, in PowerShell:
280+
>
281+
> ```powershell
282+
> # Step 1: Retrieve the current submission package JSON
283+
> msstore submission get <productId> | Out-File -Encoding utf8 package.json
284+
>
285+
> # Step 2: Edit package.json to reflect your changes (for example, a new installer URL)
286+
>
287+
> # Step 3: Pass the updated JSON to submission update
288+
> $updatedPackage = Get-Content -Raw package.json
289+
> msstore submission update <productId> $updatedPackage
290+
> ```
291+
>
292+
> For more context, see [Publish app updates to Microsoft Store with GitHub Actions](./github-actions.md).
293+
278294
#### Submission - Poll - Usage
279295
280296
```console

hub/apps/publish/msstore-dev-cli/commands.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,7 @@ msstore apps get <productId>
209209
| [get](#submission---get---usage) | Gets the metadata and package info of a specific submission.|
210210
| [getListingAssets](#submission---getlistingassets---usage) | Gets the listing assets of a specific submission. |
211211
| [updateMetadata](#submission---updatemetadata---usage) | Updates the metadata of a specific submission. |
212+
| [update](#submission---update---usage) | Updates the package of a specific submission. |
212213
| [poll](#submission---poll---usage) | Polls the status of a submission. |
213214
| [publish](#submission---publish---usage) | Publishes a specific submission. |
214215
| [delete](#submission---delete---usage) | Deletes a specific submission. |
@@ -291,6 +292,43 @@ msstore submission updateMetadata <productId> <metadata>
291292
| -v, --verbose | Print verbose output. |
292293
| -?, -h, --help | Show help and usage information. |
293294

295+
#### Submission - Update - Usage
296+
297+
```console
298+
msstore submission update <productId> <package>
299+
```
300+
301+
#### Arguments
302+
303+
| Argument | Description |
304+
| ----------- | --------------------------------------------------- |
305+
| `productId` | The Store product ID. |
306+
| `package` | The updated JSON representation of the app package. |
307+
308+
#### Options
309+
310+
| Option | Description |
311+
| ------------------------ | ---------------------------------------------------------------------- |
312+
| -s, --skipInitialPolling | Skip the initial polling before executing the action. [default: False] |
313+
| -v, --verbose | Print verbose output. |
314+
| -?, -h, --help | Show help and usage information. |
315+
316+
> [!TIP]
317+
> Use `submission get` to retrieve the current package JSON before calling `submission update`. This ensures you're working with the correct structure and current values. For example, in PowerShell:
318+
>
319+
> ```powershell
320+
> # Step 1: Retrieve the current submission package JSON
321+
> msstore submission get <productId> | Out-File -Encoding utf8 package.json
322+
>
323+
> # Step 2: Edit package.json to reflect your changes
324+
>
325+
> # Step 3: Pass the updated JSON to submission update
326+
> $updatedPackage = Get-Content -Raw package.json
327+
> msstore submission update <productId> $updatedPackage
328+
> ```
329+
>
330+
> For more context, see [Publish app updates to Microsoft Store with GitHub Actions](./github-actions.md).
331+
294332
#### Submission - Poll - Usage
295333
296334
```console

0 commit comments

Comments
 (0)