Skip to content

Update ASPIRE008 diagnostic page for GenerateAssemblyInfo requirement #288

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.

Sign up for GitHub

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
IEvangelist merged 3 commits into from
Jan 26, 2026
Merged

Update ASPIRE008 diagnostic page for GenerateAssemblyInfo requirement #288

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8ab6724
Initial plan
Copilot Jan 23, 2026
8295ac4
Update ASPIRE008 diagnostic page for GenerateAssemblyInfo requirement
Copilot Jan 23, 2026
2dcc31e
Update project file samples to modern 13.x format
Copilot Jan 26, 2026
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
50 changes: 24 additions & 26 deletions src/frontend/src/content/docs/diagnostics/aspire008.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,65 +1,63 @@
---
title: Compiler Error ASPIRE008
description: Learn more about compiler Error ASPIRE008. The installed Aspire workload is deprecated. It is recommended to migrate to the new format.
description: Learn more about compiler Error ASPIRE008. The project requires GenerateAssemblyInfo to be enabled for the AppHost to function correctly.
---

import { Aside, Badge, Steps } from '@astrojs/starlight/components';
import { Aside, Badge } from '@astrojs/starlight/components';

<Badge text="Version introduced: 8.2.3" variant='note' size='large' class:list={'mb-1'} />
<Badge text="Version introduced: 9.2.0" variant='note' size='large' class:list={'mb-1'} />

> The Aspire workload that this project depends on is now deprecated.
> '[ProjectName]' project requires GenerateAssemblyInfo to be enabled. The Aspire AppHost relies on assembly metadata attributes to locate required dependencies.

This error appears when a project uses a version of Aspire that relies on the SDK workload, which is now deprecated. The error guides you to migrate your project to a supported version of Aspire that uses the SDK approach instead of the workload.
This error appears when an Aspire AppHost project has `GenerateAssemblyInfo` set to `false`. The Aspire AppHost relies on `AssemblyMetadataAttribute` to embed DCP (Developer Control Plane) and Dashboard paths during compilation. When `GenerateAssemblyInfo` is disabled, these attributes aren't generated, causing runtime failures about missing orchestration dependencies.

## Example

The following AppHost project file uses the deprecated Aspire workload:
The following AppHost project file has `GenerateAssemblyInfo` disabled, which causes `ASPIRE008`:

```xml title="C# project file"
<Project Sdk="Microsoft.NET.Sdk">
<Project Sdk="Aspire.AppHost.Sdk/13.1.0">

<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>net8.0</TargetFramework>
<TargetFramework>net10.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<IsAspireHost>true</IsAspireHost>
<UserSecretsId>98048c9c-bf28-46ba-a98e-63767ee5e3a8</UserSecretsId>
<GenerateAssemblyInfo>false</GenerateAssemblyInfo>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="Aspire.Hosting.AppHost" Version="8.2.2" />
</ItemGroup>

</Project>
```

For more information on the Aspire SDK, see [Aspire SDK](https://learn.microsoft.com/dotnet/aspire/fundamentals/dotnet-aspire-sdk/).

## To correct this error

Follow the migration guide at [https://aka.ms/aspire/update-to-sdk](https://aka.ms/aspire/update-to-sdk) to upgrade your project to a supported version of Aspire that uses the SDK approach.

The migration typically involves:
Remove the `<GenerateAssemblyInfo>false</GenerateAssemblyInfo>` line from your project file, or set it to `true`:

<Steps>
```xml title="C# project file"
<Project Sdk="Aspire.AppHost.Sdk/13.1.0">

1. Updating your AppHost project file to use the `Aspire.AppHost.Sdk`.
1. Removing references to the deprecated workload.
1. Updating package references to supported versions.
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>net10.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<UserSecretsId>98048c9c-bf28-46ba-a98e-63767ee5e3a8</UserSecretsId>
</PropertyGroup>

</Steps>
</Project>
```

## Suppress the error

<Aside type="danger">
Suppressing this error isn't recommended, as it leaves your project depending on an unsupported version of Aspire.
Suppressing this error isn't recommended, as it will cause runtime failures when the AppHost attempts to locate orchestration dependencies.
</Aside>

If you need to temporarily suppress this error, add the following property to your project file:
If you must temporarily suppress this error, add the following property to your project file:

```xml title="C# project file"
<PropertyGroup>
<SuppressAspireWorkloadDeprecationError>true</SuppressAspireWorkloadDeprecationError>
<NoWarn>$(NoWarn);ASPIRE008</NoWarn>
</PropertyGroup>
```
2 changes: 1 addition & 1 deletion src/frontend/src/content/docs/diagnostics/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The following table lists the possible MSBuild and analyzer warnings and errors
| [ASPIRE004](/diagnostics/aspire004/) | Warning | 'Project' is referenced by an Aspire Host project, but it is not an executable. |
| [ASPIRE006](/diagnostics/aspire006/) | (Experimental) Error | Application model items must have valid names. |
| [ASPIRE007](/diagnostics/aspire007/) | Error | 'Project' requires a reference to "Aspire.AppHost.Sdk" with version "9.0.0" or greater to work correctly. |
| [ASPIRE008](/diagnostics/aspire008/) | Error | The Aspire workload that this project depends on is now deprecated. |
| [ASPIRE008](/diagnostics/aspire008/) | Error | 'Project' requires GenerateAssemblyInfo to be enabled for the AppHost to function correctly. |
| [ASPIREACADOMAINS001](/diagnostics/aspireacadomains001/) | (Experimental) Error | `ConfigureCustomDomain` is for evaluation purposes only and is subject to change or removal in future updates. |
| [ASPIREAZURE001](/diagnostics/aspireazure001/) | (Experimental) Error | Publishers are for evaluation purposes only and are subject to change or removal in future updates. |
| [ASPIREAZURE002](/diagnostics/aspireazure002/) | (Experimental) Error | Azure Container App Jobs are for evaluation purposes only and are subject to change or removal in future updates. |
Expand Down