Skip to content

Commit 312a7f7

Browse files
authored
docs: add windows (#326)
1 parent b3d2372 commit 312a7f7

File tree

3 files changed

+90
-0
lines changed

3 files changed

+90
-0
lines changed

src/content/docs/code-push/patch.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,14 @@ shorebird patch ios
3434
shorebird patch macos
3535
```
3636

37+
</TabItem>
38+
39+
<TabItem value="patch-command-windows" label="Windows (beta)">
40+
41+
```
42+
shorebird patch windows
43+
```
44+
3745
</TabItem>
3846
</Tabs>
3947

src/content/docs/code-push/release.mdx

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -270,6 +270,72 @@ shorebird release macos --flutter-version 3.24.5
270270

271271
</TabItem>
272272

273+
<TabItem value="release-windows" label="Windows (beta)">
274+
275+
Create a Windows release by running the following command:
276+
277+
`shorebird release windows`
278+
279+
Example output:
280+
281+
```
282+
$ shorebird release windows
283+
✓ Fetching apps (0.3s)
284+
✓ Building Windows app with Flutter 3.27.1 (1e0e5760ee) (18.3s)
285+
✓ Fetching releases (0.1s)
286+
287+
🚀 Ready to create a new release!
288+
289+
📱 App: sample (d0cf1d8f-e741-4f5d-b280-b794000df1cd)
290+
📦 Release Version: 1.0.0+1
291+
🕹️ Platform: windows
292+
🐦 Flutter Version: 3.27.1 (1e0e5760ee)
293+
294+
Would you like to continue? (y/N) Yes
295+
✓ Fetching releases (0.1s)
296+
✓ Creating release (0.3s)
297+
✓ Updating release status (0.1s)
298+
✓ Uploading artifacts (3.5s)
299+
✓ Updating release status (1.7s)
300+
301+
✅ Published Release 1.0.13+2!
302+
303+
Windows executable created at build/windows/x64/runner/Release
304+
305+
To create a patch for this release, run shorebird patch --platforms=windows --release-version=1.0.0+1
306+
307+
Note: shorebird patch --platforms=windows without the --release-version option will patch the current version of the app.
308+
```
309+
310+
If your application supports flavors or multiple release targets, you can specify the flavor and target using the `--flavor` and `--target` options:
311+
312+
```bash
313+
shorebird release windows --target ./lib/main_development.dart --flavor development
314+
```
315+
316+
:::note
317+
`shorebird release` wraps `flutter build` and can take any argument `flutter
318+
build` can. To pass arguments to the underlying `flutter build` you need to put
319+
`flutter build` arguments after a `--` separator. For example: `shorebird
320+
release android -- --dart-define="foo=bar"` will define the `"foo"` environment
321+
variable inside Dart as you might have done with `flutter build` directly. In
322+
Powershell the `--` separator must be quoted: `'--'`.
323+
:::
324+
325+
:::note
326+
By default `shorebird release` uses the Flutter version bundled within the shorebird installation.
327+
328+
That version can be checked by running `shorebird doctor`
329+
:::
330+
331+
To release with a different Flutter version, you can specify the version using the `--flutter-version` flag.
332+
333+
```
334+
shorebird release windows --flutter-version 3.27.1
335+
```
336+
337+
</TabItem>
338+
273339
</Tabs>
274340

275341
## Manage Releases

src/content/docs/index.mdx

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,14 @@ shorebird release ios
208208
shorebird release macos
209209
```
210210

211+
</TabItem>
212+
213+
<TabItem value="windows" label="Windows (beta)">
214+
215+
```sh
216+
shorebird release windows
217+
```
218+
211219
</TabItem>
212220
</Tabs>
213221

@@ -293,6 +301,14 @@ shorebird patch macos
293301

294302
</TabItem>
295303

304+
<TabItem value="indows" label="Windows (beta)">
305+
306+
```sh
307+
shorebird patch windows
308+
```
309+
310+
</TabItem>
311+
296312
</Tabs>
297313

298314
### See the patch in action

0 commit comments

Comments
 (0)