Skip to content
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

docs: Misc publishing updates #18508

Merged
merged 1 commit into from
Oct 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/articles/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@
href: xref:uno.publishing.desktop
- name: Publishing for WebAssembly
href: xref:uno.publishing.webassembly
- name: Publishing for Windows
- name: Publishing for Windows App SDK
topicHref: xref:uno.publishing.windows
items:
- name: Build Packaged Unsigned Apps
Expand Down
2 changes: 1 addition & 1 deletion doc/articles/uno-publishing-android.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ To build your app from the CLI, on Windows, Linux, or macOS:

- Once the build is done, the output `.apk` and `.aab` files are located in the `./publish` folder.

## Publishing your app
## Publishing your Android App

Publishing an Uno Platform app uses the same steps as .NET for Android-based technologies.

Expand Down
34 changes: 22 additions & 12 deletions doc/articles/uno-publishing-desktop.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@ If you wish to do a self-contained publish, run the following instead:
dotnet publish -f net8.0-desktop -r {{RID}} -p:SelfContained=true
```

Where `{{RID}}` specifies the chosen OS and Architecture (e.g. win-x64). Again when targeting Windows, cross-publishing is not supported.
Where `{{RID}}` specifies the chosen OS and Architecture (e.g. win-x64). When targeting Windows, cross-publishing to architectures other than the currently running one is not supported.

### macOS App Bundles

We now support generating .app bundles on macOS machines. From the CLI run:
We now support generating `.app` bundles on macOS machines. From the CLI run:

```shell
dotnet publish -f net8.0-desktop -p:PackageFormat=app
Expand Down Expand Up @@ -84,22 +84,22 @@ The following must be installed and configured:
> [!NOTE]
> Docker may interfere with Lxd causing network connectivity issues, for solutions see: https://documentation.ubuntu.com/lxd/en/stable-5.0/howto/network_bridge_firewalld/#prevent-connectivity-issues-with-lxd-and-docker
#### Publishing A Snap
#### Generate a Snap file

To publish a snap, run:
To generate a snap file, run the following:

```shell
dotnet publish -f net8.0-desktop -r {{RID}} -p:SelfContained=true -p:PackageFormat=snap
```

Where `{{RID}}` is either `linux-x64` or `linux-arm64`.
Where `{{RID}}` is either `linux-x64` or `linux-arm64`. The generated snap file is located in the `publish` folder.

We generate snap manifests in classic confinement mode and a .desktop file by default.
Uno Platform generates snap manifests in classic confinement mode and a `.desktop` file by default.

If you wish to customize your snap manifest, you will need to pass the following MSBuild properties:

- SnapManifest
- DesktopFile
- `SnapManifest`
- `DesktopFile`

The `.desktop` filename MUST conform to the Desktop File spec.

Expand All @@ -108,14 +108,24 @@ If you wish, you can generate a default snap manifest and desktop file by runnin
> [!NOTE]
> .NET 9 publishing and cross-publishing are not supported as of Uno 5.5, we will support .NET 9 publishing soon.
#### Publish your Snap Package

You can install your app on your machine using the following:

```bash
sudo snap install MyApp_1.0_amd64.snap --dangerous –classic
```

You can also publish your app to the [Snap store](https://snapcraft.io/store).

## Limitations

- NativeAOT is not supported
- R2R is not supported
- Single file publish is not supported
- NativeAOT is not yet supported
- R2R is not yet supported
- Single file publish is not yet supported

> [!NOTE]
> Publishing is a work in progress
> Publishing is a [work in progress](https://github.com/unoplatform/uno/issues/16440)
## Links

Expand Down
2 changes: 1 addition & 1 deletion doc/articles/uno-publishing-ios.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,6 @@ To build your app from the CLI on macOS:

The output `.ipa` file will be in the `publish` folder.

## Publishing your app
## Publishing your app on the App Store

Publishing your app is done through [the transporter app](https://developer.apple.com/help/app-store-connect/manage-builds/upload-builds) on macOS.
2 changes: 1 addition & 1 deletion doc/articles/uno-publishing-maccatalyst.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,6 @@ The output `.pkg` file will be in the `publish` folder.
> [!TIP]
> To create a `.app` folder, set the `CreatePackage` parameter to `false`.

## Publishing your app
## Publishing your app om the App Store

Publishing your app is done through [the transporter app](https://developer.apple.com/help/app-store-connect/manage-builds/upload-builds) on macOS.
12 changes: 6 additions & 6 deletions doc/articles/uno-publishing-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ uid: uno.publishing.overview

## Packaging

- [Packaging for Desktop](xref:uno.publishing.desktop)
- [Packaging for WebAssembly](xref:uno.publishing.webassembly)
- [Packaging for Windows](xref:uno.publishing.windows)
- [Packaging for iOS](xref:uno.publishing.ios)
- [Packaging for Android](xref:uno.publishing.android)
- [Packaging for Mac Catalyst](xref:uno.publishing.maccatalyst)
- [Packaging for Desktop](xref:uno.publishing.desktop) (using `netX.0-desktop`)
- [Packaging for WebAssembly](xref:uno.publishing.webassembly) (using `netX.0-browserwasm`)
- [Packaging for Windows App SDK](xref:uno.publishing.windows) (using `netX.0-windows10.yyy`)
- [Packaging for iOS](xref:uno.publishing.ios) (using `netX.0-ios`)
- [Packaging for Android](xref:uno.publishing.android) (using `netX.0-android`)
- [Packaging for Mac Catalyst](xref:uno.publishing.maccatalyst) (using `netX.0-maccatalyst`)
2 changes: 1 addition & 1 deletion doc/articles/uno-publishing-webassembly.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ To build your app from the CLI, on Windows, Linux, or macOS:

Once done, you can head over to [publishing section](xref:uno.publishing.webassembly#publishing).

## Publishing
## Publishing your WebAssembly App

Publishing your app can be done to different servers and cloud providers.

Expand Down
2 changes: 1 addition & 1 deletion doc/articles/uno-publishing-windows-packaged-signed.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ To build your solution:

Notice that this command does not contain the `/r`.

## Install the signed app
## Install the signed Windows app

To install the app:

Expand Down
2 changes: 1 addition & 1 deletion doc/articles/uno-publishing-windows-packaged-unsigned.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ To build your solution:

Notice that this command does not contain the `/r`.

## Install the unsigned app
## Install the unsigned Windows app

To install the app:

Expand Down
2 changes: 1 addition & 1 deletion doc/articles/uno-publishing-windows-unpackaged.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ To publish your app:

In order to build for additional platforms, change the `Platform` parameter to `x86` or `arm64` to create additional MSIX files.

## Publish the app
## Publish the Windows app

Publishing your app can be done through different means:

Expand Down
3 changes: 2 additions & 1 deletion doc/articles/uno-publishing-windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
uid: uno.publishing.windows
---

# Publishing Your App for Windows
# Publishing Your App for Windows App SDK

## Preparing For Publish

Expand All @@ -12,3 +12,4 @@ Using the Windows App SDK, it's possible to side-load an app using the following

- [Build an unsigned packaged app](xref:uno.publishing.windows.sideload.packaged.unsigned)
- [Build a signed packaged app](xref:uno.publishing.windows.sideload.packaged.signed)
- [Build an unpackaged app](xref:uno.publishing.windows.sideload.unpackaged.unsigned)
Loading