-
Notifications
You must be signed in to change notification settings - Fork 82
[docs] Document ASPIREWATCH001 run mode configuration diagnostic #1471
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
base: release/13.5
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| --- | ||
| title: Compiler Warning ASPIREWATCH001 | ||
| seoTitle: "ASPIREWATCH001: Experimental run mode configuration APIs" | ||
| description: Learn what causes the Aspire compiler warning ASPIREWATCH001 and how to fix it so your AppHost builds cleanly. | ||
| --- | ||
|
|
||
| import { Badge } from '@astrojs/starlight/components'; | ||
|
|
||
| <Badge | ||
| text="Version introduced: 13.5" | ||
| variant="note" | ||
| size="large" | ||
| class:list={'mb-1'} | ||
| /> | ||
|
|
||
| > Run mode configuration types and members are for evaluation purposes only and are subject to change or removal in future updates. Suppress this diagnostic to proceed. | ||
|
|
||
| This diagnostic warning is reported when using experimental run mode configuration APIs in Aspire, including: | ||
|
|
||
| - `RunConfiguration` class | ||
| - `DistributedApplicationExecutionContext.RunConfiguration` property | ||
| - `DistributedApplicationExecutionContextOptions.RunConfiguration` property | ||
|
|
||
| These APIs let integrations vary how their resources are launched based on the kind of run being performed, without changing the core hosting behavior. In publish mode, every property on `RunConfiguration` holds its default value. | ||
|
|
||
| ## Example | ||
|
|
||
| The following code generates `ASPIREWATCH001`: | ||
|
|
||
| ```csharp title="Reading run mode configuration" | ||
| var builder = DistributedApplication.CreateBuilder(args); | ||
|
|
||
| if (builder.ExecutionContext.IsRunMode) | ||
| { | ||
| var runConfiguration = builder.ExecutionContext.RunConfiguration; | ||
|
|
||
| if (runConfiguration.WatchEnabled) | ||
| { | ||
| // Launch resources so source changes are hot-reloaded. | ||
| } | ||
| } | ||
|
|
||
| builder.Build().Run(); | ||
| ``` | ||
|
|
||
| ## Understanding run mode configuration | ||
|
|
||
| `RunConfiguration` holds settings that only apply when the AppHost is running in [run mode](/app-host/resource-lifetimes/) (as opposed to publish mode). Integrations use it to vary how their resources are launched without changing the core hosting behavior. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [doc-tester / Phase B] The "run mode" link target doesn't explain run mode. This links run mode to On this build, [run mode](/get-started/glossary/#run-mode/) |
||
|
|
||
| ### `WatchEnabled` | ||
|
|
||
| Indicates that resources should start in watch mode if able. Integrations that support watch can launch their resources so that source changes are hot-reloaded. This is a hint: integrations that cannot watch their resources should start them in the normal fashion. | ||
|
|
||
| ## To suppress this warning | ||
|
|
||
| Suppress the warning with either of the following methods: | ||
|
|
||
| - Set the severity of the rule in the _.editorconfig_ file. | ||
|
|
||
| ```ini title=".editorconfig" | ||
| [*.{cs,vb}] | ||
| dotnet_diagnostic.ASPIREWATCH001.severity = none | ||
| ``` | ||
|
|
||
| For more information about editor config files, see [Configuration files for code analysis rules](/diagnostics/overview/#suppress-in-the-editorconfig-file). | ||
|
|
||
| - Add the following `PropertyGroup` to your project file: | ||
|
|
||
| ```xml title="C# project file" | ||
| <PropertyGroup> | ||
| <NoWarn>$(NoWarn);ASPIREWATCH001</NoWarn> | ||
| </PropertyGroup> | ||
| ``` | ||
|
|
||
| - Suppress in code with the `#pragma warning disable ASPIREWATCH001` directive: | ||
|
|
||
| ```csharp title="Suppressing the warning" | ||
| var builder = DistributedApplication.CreateBuilder(args); | ||
|
|
||
| #pragma warning disable ASPIREWATCH001 | ||
| var runConfiguration = builder.ExecutionContext.RunConfiguration; | ||
| #pragma warning restore ASPIREWATCH001 | ||
|
|
||
| builder.Build().Run(); | ||
| ``` | ||
Uh oh!
There was an error while loading. Please reload this page.