Documentation section: Project
Release notes
Stable release history for Purview.Aspire.ResourceKit, with the highlights that matter when you
upgrade from the 1.0.0-prerelease.* line. The full, machine-readable history lives in
CHANGELOG.md and on
the GitHub releases page.
2.2.0 (unreleased)
Section titled “2.2.0 (unreleased)”BuildResourceis generated from a declared path. ADotnetProjectResource,ViteAppResourceorNextJsAppResourcekit that declaresProjectPath/ResourcePathand writes no override getsAddDotnetProject,AddViteApporAddNextJsAppgenerated, so the path is stated once, on the attribute. A hand-written override still wins, and SG0018 still validates it. See Project Resources.- SG0044 (Info) and its code fix remove an override that only repeats the generated call, moving the path into the attribute first when it isn’t declared there.
- Aspire 17 Project V2 —
[ResourceDefinition<DotnetProjectResource>("api", ProjectPath = "../Api/Api.csproj")]withAddDotnetProject. The generator emitsResourceKitBase<THostKit, DotnetProjectResource>; SG0018 validates the declared path (normalising\//), SG0019 validates an explicit base, and the new SG0041 reports aProjectPathon a resource that is notDotnetProjectResource. See Project Resources. - Aspire 13.6 still supported. The package keeps the
Aspire.Hosting13.6.5 floor and resolvesDotnetProjectResourceby metadata name, so a 13.6 consumer is unaffected.verify-consumersbuilds both a 13.6 and a 17 consumer from the packed package. - Path-based resources.
ResourcePathdeclares the path forAddDotnetProjectand the Aspire JavaScriptAdd*Appmethods, validated by SG0018. SG0042 reports aProjectPaththat disagrees with it and SG0043 a resource type that is not added by path. - Typed paths.
<ResourceKitProject>and<ResourceKitPath>items generateAppHostProjectsconstants (Name,Path) to use on the attribute; RKP0001–RKP0003 report a missing path or an invalid name.
- Breaking: .NET 10 is the minimum. The
net8.0andnet9.0targets are gone; a consuming AppHost must be onnet10.0ornet11.0, and the package shipslib/net10.0(the floor) andlib/net11.0(the newest leg). See Supported target frameworks and .NET 11 toolchain and feature adoption. - .NET 11 leg and tooling — the repository builds with the .NET 11 GA SDK,
Purview.BuildSdk2.0.1 and TUnit 1.83. The net11.0 leg opts into the SDK’s Runtime Async (PurviewRuntimeAsync=true) and takes its memory-safety rules; the net10.0 leg keeps the 10.0.15Microsoft.Extensions.*floor.OptionsHelper.PathFor<TOptions, TValue>adds a non-boxing selector overload, and pack validation now compares against the published 1.1.0 baseline. - Resource groups.
[ResourceGroup]and[InGroup<TGroup>]gather kits under named, nestable groups. A group can be switched off or given a mode from configuration, and in run mode it appears as a node in the dashboard with its kits nested underneath. See Groups and URLs. - Named dashboard URLs.
[ResourceUrl]and[EndpointUrl]declare a kit’s or group’s dashboard links as options. A relative URL adds one link for one endpoint, instead of rewriting every endpoint URL asWithUrl("/path")does. - Diagnostics SG0021-SG0031 for groups and URLs. A group can never become its own ancestor or member.
- Parent and child resource kits (issue #57).
Parent = typeof(TParentKit)gives the child a typedParent, the parent a typed child property, parent-before-child build ordering, inherited enablement, and nested options (<HostKit>:<Parent>:<Child>). VNET/subnets, SQL server/database, Service Bus and storage account/container hierarchies are supported without a second composition framework. See Parent and child resource kits. - Diagnostics SG0032-SG0038 for self-parenting, cycles, unavailable parents, child property collisions,
duplicate child property names, and generated
Parentmember collisions. Manual graphs are validated at runtime before any Aspire resource is created. - SG0039 warns when a child’s explicit primary group differs from its parent’s, because visual placement follows the child’s group (or an existing Aspire parent chain), not the ResourceKit hierarchy.
- SG0040 (Info) and its code fix remove a redundant
.ResourceBuilderhop from a kit receiver:Parent.ResourceBuilder.AddDatabase(...)becomesParent.AddDatabase(...).
The first stable release. The public surface that shipped during the prerelease line is now frozen under semantic versioning.
Highlights
Section titled “Highlights”- Attributes drive generation —
[HostKit]and[ResourceDefinition]/[ResourceDefinition<TResource>]produce the host kit, resource kit skeletons, typed options, and the AppHost extension method. See Attributes Reference and Generated Output. - Deterministic lifecycle —
Build/BuildResource(...)constructs resources, thenConfigure/ConfigureResource()wires them together. See Lifecycle: Build vs Configure. - Declarative enablement —
IsEnabledandIsResourceEnabled(builder). See Enablement. - Typed, extendable options — generated
sealed partialoptions bound from configuration. See Configuration and Options. - Test-friendly overrides —
OptionsHelperfor args, environment variables, and flattening. See OptionsHelper and Testing with ResourceKit. - Project resources — first-class
AddProject<T>()support with SG0018/SG0019 validation. See Project Resources. - Diagnostics SG0001–SG0020 with an IDE code fix for SG0020. See Diagnostics.
- Agent skills —
1.0.0bundledaspire-apphost-to-resourcekitand copied it into.agents/skills/**on build. That delivery is withdrawn: skills now install through the skills CLI, and the authored set has changed. See Agent Skills.
Upgrade notes
Section titled “Upgrade notes”- No public API changes are required when moving from
1.0.0-prerelease.*to1.0.0. - Pin
Purview.Aspire.ResourceKitto1.0.0(or a later compatible1.x).