Skip to content

Create dotnet-desktop.yml #318

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
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
115 changes: 115 additions & 0 deletions .github/workflows/dotnet-desktop.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.

# This workflow will build, test, sign and package a WPF or Windows Forms desktop application
# built on .NET Core.
# To learn how to migrate your existing application to .NET Core,
# refer to https://docs.microsoft.com/en-us/dotnet/desktop-wpf/migration/convert-project-from-net-framework
#
# To configure this workflow:
#
# 1. Configure environment variables
# GitHub sets default environment variables for every workflow run.
# Replace the variables relative to your project in the "env" section below.
#
# 2. Signing
# Generate a signing certificate in the Windows Application
# Packaging Project or add an existing signing certificate to the project.
# Next, use PowerShell to encode the .pfx file using Base64 encoding
# by running the following Powershell script to generate the output string:
#
# $pfx_cert = Get-Content '.\SigningCertificate.pfx' -Encoding Byte
# [System.Convert]::ToBase64String($pfx_cert) | Out-File 'SigningCertificate_Encoded.txt'
#
# Open the output file, SigningCertificate_Encoded.txt, and copy the
# string inside. Then, add the string to the repo as a GitHub secret
# and name it "Base64_Encoded_Pfx."
# For more information on how to configure your signing certificate for
# this workflow, refer to https://github.com/microsoft/github-actions-for-desktop-apps#signing
#
# Finally, add the signing certificate password to the repo as a secret and name it "Pfx_Key".
# See "Build the Windows Application Packaging project" below to see how the secret is used.
#
# For more information on GitHub Actions, refer to https://github.com/features/actions
# For a complete CI/CD sample to get started with GitHub Action workflows for Desktop Applications,
# refer to https://github.com/microsoft/github-actions-for-desktop-apps

name: .NET Core Desktop

on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]

jobs:

build:

strategy:
matrix:
configuration: [Debug, Release]

runs-on: windows-latest # For a list of available runner types, refer to
# https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on

env:
Solution_Name: your-solution-name # Replace with your solution name, i.e. MyWpfApp.sln.
Test_Project_Path: your-test-project-path # Replace with the path to your test project, i.e. MyWpfApp.Tests\MyWpfApp.Tests.csproj.
Wap_Project_Directory: your-wap-project-directory-name # Replace with the Wap project directory relative to the solution, i.e. MyWpfApp.Package.
Wap_Project_Path: your-wap-project-path # Replace with the path to your Wap project, i.e. MyWpf.App.Package\MyWpfApp.Package.wapproj.

Comment on lines +58 to +63
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Critical: Replace all placeholder env variables.

The env section uses placeholders (your-solution-name, your-test-project-path, etc.). If these aren’t updated to actual file names/paths, the workflow will fail immediately.
Please replace:

  • Solution_Name → e.g. MyWpfApp.sln
  • Test_Project_Path → e.g. MyWpfApp.Tests/MyWpfApp.Tests.csproj
  • Wap_Project_Directory → e.g. MyWpfApp.Package
  • Wap_Project_Path → e.g. MyWpfApp.Package/MyWpfApp.Package.wapproj
🤖 Prompt for AI Agents
In .github/workflows/dotnet-desktop.yml around lines 58 to 63, the environment
variables are set to placeholder values that will cause the workflow to fail.
Replace these placeholders with the actual solution and project names/paths
relevant to your project, such as setting Solution_Name to your real solution
file name (e.g., MyWpfApp.sln), Test_Project_Path to the correct test project
file path, Wap_Project_Directory to the actual Wap project directory name, and
Wap_Project_Path to the correct Wap project file path.

steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0

# Install the .NET Core workload
- name: Install .NET Core
uses: actions/setup-dotnet@v4
with:
dotnet-version: 8.0.x

# Add MSBuild to the PATH: https://github.com/microsoft/setup-msbuild
- name: Setup MSBuild.exe
uses: microsoft/setup-msbuild@v2

# Execute all unit tests in the solution
- name: Execute unit tests
run: dotnet test

# Restore the application to populate the obj folder with RuntimeIdentifiers
- name: Restore the application
run: msbuild $env:Solution_Name /t:Restore /p:Configuration=$env:Configuration
env:
Configuration: ${{ matrix.configuration }}

# Decode the base 64 encoded pfx and save the Signing_Certificate
- name: Decode the pfx
run: |
$pfx_cert_byte = [System.Convert]::FromBase64String("${{ secrets.Base64_Encoded_Pfx }}")
$certificatePath = Join-Path -Path $env:Wap_Project_Directory -ChildPath GitHubActionsWorkflow.pfx
[IO.File]::WriteAllBytes("$certificatePath", $pfx_cert_byte)

# Create the app package by building and packaging the Windows Application Packaging project
- name: Create the app package
run: msbuild $env:Wap_Project_Path /p:Configuration=$env:Configuration /p:UapAppxPackageBuildMode=$env:Appx_Package_Build_Mode /p:AppxBundle=$env:Appx_Bundle /p:PackageCertificateKeyFile=GitHubActionsWorkflow.pfx /p:PackageCertificatePassword=${{ secrets.Pfx_Key }}
env:
Appx_Bundle: Always
Appx_Bundle_Platforms: x86|x64
Appx_Package_Build_Mode: StoreUpload
Configuration: ${{ matrix.configuration }}

Comment on lines +98 to +105
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Critical: Pass the AppxBundlePlatforms parameter.

You define Appx_Bundle_Platforms but never pass it to MSBuild. Without it, packaging for x86|x64 won’t be honored. Apply this diff:

- run: msbuild $env:Wap_Project_Path \
-   /p:Configuration=$env:Configuration \
-   /p:UapAppxPackageBuildMode=$env:Appx_Package_Build_Mode \
-   /p:AppxBundle=$env:Appx_Bundle \
-   /p:PackageCertificateKeyFile=GitHubActionsWorkflow.pfx \
-   /p:PackageCertificatePassword=${{ secrets.Pfx_Key }}
+ run: msbuild $env:Wap_Project_Path \
+   /p:Configuration=$env:Configuration \
+   /p:UapAppxPackageBuildMode=$env:Appx_Package_Build_Mode \
+   /p:AppxBundle=$env:Appx_Bundle \
+   /p:AppxBundlePlatforms=$env:Appx_Bundle_Platforms \
+   /p:PackageCertificateKeyFile=GitHubActionsWorkflow.pfx \
+   /p:PackageCertificatePassword=${{ secrets.Pfx_Key }}
🤖 Prompt for AI Agents
In .github/workflows/dotnet-desktop.yml around lines 98 to 105, the environment
variable Appx_Bundle_Platforms is defined but not passed as a parameter to the
msbuild command. To fix this, add the parameter
/p:AppxBundlePlatforms=$env:Appx_Bundle_Platforms to the msbuild run command so
that the specified platforms (x86|x64) are correctly used during packaging.

# Remove the pfx
- name: Remove the pfx
run: Remove-Item -path $env:Wap_Project_Directory\GitHubActionsWorkflow.pfx

# Upload the MSIX package: https://github.com/marketplace/actions/upload-a-build-artifact
- name: Upload build artifacts
uses: actions/upload-artifact@v4
with:
name: MSIX Package
path: ${{ env.Wap_Project_Directory }}\AppPackages