microsoft / microsoft/aspire.dev

Improve Custom Resource Tutorial

Open
#539 1 comment 0 reactions 1 assignee View on GitHub

@IEvangelist is already working on this.

Since Jun 2, 2026.

Dominant language
MDX
Stars
193
Forks
87
Avg merge
1d 22h
Merged PRs (30d)
73

Description

https://aspire.dev/integrations/custom-integrations/hosting-integrations/

  • Secure Networking section should be updated for the WithHttpsConfiguration apis.
  • Add a healthcheck (http://localhost:1080/healthz)
  • Document how to test the integration with DistributedApplicationTestingBuilder.

There is a gtocha to be aware of when creating the test project:

  • For tests, you'll likely want to use DistributedApplicationTestingBuilder.Create() rather than DistributedApplicationTestingBuilder.Create<T>. This requires you to configure your test project to use the aspire sdk 
    <Project Sdk="Aspire.AppHost.Sdk/13.1.0">
    This however introduces a few complications
    • You'll need to specify IsAspireProjectResource on the ProjectReference to your integration project.
    • aspire update will get confused in the future when you try to update packages. https://github.com/dotnet/aspire/issues/12053,

For the test, a simple check making sure the resoruce goes healthy should suffice - something like https://github.com/afscrome/aspire-inmemorywebserver-resource/blob/0ed1e4845d89b9080291c8f66bf2780d2f48d9c3/test/HostingIntegration/WaitingTests.cs#L5-L22

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.