-
Notifications
You must be signed in to change notification settings - Fork 41
docs: document Windows MSIX from a Shorebird release (shorebirdtech/shorebird#2801) #674
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.
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
AbhishekDoshi26
merged 4 commits into
shorebirdtech:main
from
AzazelSensei:docs-windows-msix-2801
Sep 17, 2026
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
949fe5e
docs: document Windows MSIX from a Shorebird release
AzazelSensei 3c7f8e8
docs: add Store identity fields to the Windows MSIX example
AzazelSensei ab63eff
docs: apply Windows MSIX review wording and CI fixes
AzazelSensei 6ffe2e7
Merge branch 'main' into docs-windows-msix-2801
AbhishekDoshi26 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -85,6 +85,7 @@ words: | |
| - mipmap | ||
| - mobileprovision | ||
| - mozallowfullscreen | ||
| - msix | ||
| - notlike | ||
| - nubank | ||
| - opengraph | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
75 changes: 75 additions & 0 deletions
75
src/content/docs/flutter-concepts/releasing-flutter-apps/windows.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| --- | ||
| title: Releasing for Windows | ||
| description: | ||
| Build a Shorebird Windows release, then package an MSIX from that output | ||
| without letting package:msix rebuild the app with stock Flutter. | ||
| sidebar: | ||
| label: Windows (Microsoft Store) | ||
| order: 4 | ||
| --- | ||
|
|
||
| To submit an app to the Microsoft Store, you need an **MSIX** package. | ||
| [`package:msix`](https://pub.dev/packages/msix) is a common way to produce that | ||
| file from a Flutter Windows build. By default it runs `flutter build windows` | ||
| with the Flutter SDK on your `PATH`, not Shorebird's Flutter. That rebuild is | ||
| not a Shorebird release, so patches will not apply. | ||
|
|
||
| Build with Shorebird first, then tell `package:msix` to package the existing | ||
| output. | ||
|
|
||
| ## Step 1: Create a Shorebird Windows release | ||
|
|
||
| ```bash | ||
| shorebird release windows | ||
| ``` | ||
|
|
||
| The Windows executable is written to `build/windows/x64/runner/Release`. See | ||
| [Create a Release](/code-push/release/) for flavors, targets, and | ||
| `--flutter-version`. | ||
|
|
||
| ## Step 2: Disable the MSIX rebuild | ||
|
|
||
| Add [`package:msix`](https://pub.dev/packages/msix) as a dev dependency if you | ||
| do not already use it: | ||
|
|
||
| ```bash | ||
| flutter pub add dev:msix | ||
| ``` | ||
|
|
||
| Then set `build_windows: false` in the `msix_config` section of `pubspec.yaml`: | ||
|
|
||
| ```yaml | ||
| msix_config: | ||
| display_name: My App | ||
| publisher_display_name: Example | ||
| publisher: CN=00000000-0000-0000-0000-000000000000 | ||
| identity_name: com.example.myapp | ||
| msix_version: 1.0.0.0 | ||
| store: true | ||
| build_windows: false | ||
| ``` | ||
|
|
||
| `build_windows: false` skips `flutter build windows` and packages the directory | ||
| Shorebird already produced. | ||
|
|
||
| Copy `identity_name`, `publisher`, and `publisher_display_name` from Partner | ||
| Center (Product identity). With `store: true`, `package:msix` refuses to build | ||
| if any of them is missing. The fourth part of `msix_version` must be `0` for | ||
| Store submissions. | ||
|
|
||
| ## Step 3: Create the MSIX package | ||
|
|
||
| ```bash | ||
| dart run msix:create | ||
| ``` | ||
|
|
||
| Submit the generated `.msix` file to the Microsoft Store. | ||
|
|
||
| :::caution | ||
|
|
||
| After `shorebird release windows`, do not run `flutter build windows`, or | ||
| `msix:create` without `build_windows: false`. Those commands rebuild with | ||
| non-Shorebird Flutter and overwrite the build output, so the resulting MSIX will | ||
| not receive patches. | ||
|
|
||
| ::: | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.