Nextended.Aspire — API reference

🇩🇪 Diese Seite auf Deutsch

The complete public surface of Nextended.Aspire, generated from the compiled assembly.

Generated

This page is generated by tools/ApiRef from the compiled assembly — it includes members with no XML comment and therefore cannot drift from the code. Do not edit by hand.

↩ Back to the package page

Nextended.Aspire

DevCertHostingExtensions

static class

No description.

DistributedApplicationBuilderExtensions

static class

Extension methods for IResourceBuilder1` that provide conditional operations such as waiting for dependencies and adding references or environment variables to a resource.

DistributedApplicationExtensions

static class

No description.

DockerHelper

class

No description.

Constructors

• DockerHelper()

Methods

• EnsureDockerIsRunning() : void
• IsDockerInstalled() : bool
• IsDockerRunning() : bool
• StartDocker() : void

GithubRepositoryExtensions

static class

Runs any GitHub (or other git) repository as an Aspire container resource: the repo is cloned/updated on the host at build time and built via its own — or a generated — Dockerfile.

Methods

• EnsureGitCheckout(string repository, string gitRef, string dir) : void
  Clones repository@gitRef into dir (shallow), or refreshes an existing checkout to that ref. A failed refresh (offline) keeps the existing checkout; the initial clone is required and throws with a clear message.

GithubRepositoryOptions

class

Options for AddGithubRepository / WithGithubSource``1.

Constructors

• GithubRepositoryOptions()

Properties

• CheckoutDirectory : string { get; set; }
  Directory the repository is cloned into. Default {AppHostDirectory}/obj/github/{resourceName}. The checkout itself lives in a src subfolder; a generated Dockerfile is written next to it.
• ContextSubPath : string { get; set; }
  Subdirectory of the checkout to use as the docker build context. Default: repo root.
• DockerfileContent : string { get; set; }
  Content of a Dockerfile to generate next to the checkout (for repos that ship none). Line endings are normalized to LF. When null, the repo's own Dockerfile is used (see DockerfilePath).
• DockerfilePath : string { get; set; }
  Path of the Dockerfile inside the checkout, relative to the repo root — only used when DockerfileContent is null. Default: the builder's own default (Dockerfile in the context).
• GitRef : string { get; set; }
  Git branch/tag/commit-ish to check out. Default main. Pin a tag for reproducible builds.

Projects

Nextended_Aspire

class

Metadata for the Aspire AppHost project.

Properties

• ProjectPath : string { get; }
  The path to the Aspire Host project.

↩ Back to the package page