docs: document Windows MSIX from a Shorebird release (shorebirdtech/shorebird#2801) - #674
Conversation
package:msix rebuilds with stock Flutter unless build_windows is false. Document packaging the output of shorebird release windows instead.
AbhishekDoshi26
left a comment
AbhishekDoshi26
left a comment
There was a problem hiding this comment.
The approach is right: build_windows: false does skip flutter build windows and packages the existing build/windows/x64/runner/Release output. A few things would trip up anyone copying the example straight into a Store submission, though.
Copy publisher fields from Partner Center, set store: true, and use msix_version 1.0.0.0. Clarify that a stock Flutter rebuild only overwrites local output.
There was a problem hiding this comment.
Thanks for the updates. All three earlier comments are addressed, and I checked the new text against the msix 3.18.0 source: with store: true it refuses to build without identity_name, publisher_display_name, and publisher, and it skips signing. It also finds build/windows/x64/runner/Release on its own.
The content is close. Please address everything below before merge:
CI (currently failing in three places)
- build (format check): Prettier flags
windows.mdx. The prose is wrapped at about 75 columns instead of 80, sonpx prettier --write src/content/docs/flutter-concepts/releasing-flutter-apps/windows.mdxfixes it. - style-check (Vale): the Step 3 heading fails
Shorebird.Headings. See the inline comment. - spell-check: the failure is in the PR title, not the file (
:1:24 - Unknown word (MSIX)). The inlinecspell:wordsdirective only applies to the page. Addingmsixtowords:in.cspell.yamlfixes the title check, and then the inline directive can go.
Wording (see inline comments)
- Use "Microsoft Store" everywhere instead of "Windows Store".
- Reword the first sentence of the caution box.
- In
release.mdx, say thatbuild_windowsgoes inmsix_configinpubspec.yaml.
Once these are in and CI is green, this is ready to approve.
AbhishekDoshi26
left a comment
AbhishekDoshi26
left a comment
There was a problem hiding this comment.
Marking this as changes requested. Please address all six items in my review above: the three CI failures (Prettier, the Vale heading, and msix in .cspell.yaml) and the three inline wording fixes. I'll approve once they're in and CI is green.
Use Microsoft Store throughout, rename the Step 3 heading so Vale passes, put build_windows on msix_config, add msix to cspell, and rewrap the page to 80 columns.
|
Addressed the six items: Prettier wrap, Vale heading, msix in .cspell.yaml, Microsoft Store wording, the caution, and the release.mdx msix_config note. |
AbhishekDoshi26
left a comment
AbhishekDoshi26
left a comment
There was a problem hiding this comment.
Thanks! All six items are addressed and CI passes. Approving.
2 participants
Status
READY
Description
package:msixrebuilds with stock Flutter by default, which is not a Shorebird release. I added a Windows store page that usesshorebird release windowsandbuild_windows: false, and linked it from the release guide.Related to shorebirdtech/shorebird#2801