Class NetlifyDeployOptions

Namespace

Aspire.Hosting

Assembly

IEvangelist.Aspire.Hosting.Netlify.dll

Options for deploying to Netlify using the Netlify CLI. For more information, see Netlify CLI deploy command documentation.

[AspireDto]
public sealed class NetlifyDeployOptions

Inheritance

object

NetlifyDeployOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Alias

Specifies the alias for deployment, the string at the beginning of the deploy subdomain. Useful for creating predictable deployment URLs. Avoid setting an alias string to the same value as a deployed branch. Alias doesn't create a branch deploy and can't be used in conjunction with the branch subdomain feature. Maximum 37 characters.

public string? Alias { get; set; }

Property Value

string

Auth

Netlify auth token - can be used to run this command without logging in.

public string? Auth { get; set; }

Property Value

string

Context

Specify a deploy context for environment variables read during the build ("production", "deploy-preview", "branch-deploy", "dev") or "branch:your-branch" where "your-branch" is the name of a branch. Default: dev

public string? Context { get; set; }

Property Value

string

CreateSite

Create a new site and deploy to it. Optionally specify a name, otherwise a random name will be generated. Requires Team flag if you have multiple teams.

public string? CreateSite { get; set; }

Property Value

string

Debug

Print debugging information.

public bool Debug { get; set; }

Property Value

bool

Dir

Specify a folder to deploy.

public string? Dir { get; set; }

Property Value

string

Filter

For monorepos, specify the name of the application to run the command in.

public string? Filter { get; set; }

Property Value

string

Functions

Specify a functions folder to deploy.

public string? Functions { get; set; }

Property Value

string

Json

Output deployment data as JSON.

public bool Json { get; set; }

Property Value

bool

Message

A short message to include in the deploy log.

public string? Message { get; set; }

Property Value

string

NoBuild

Do not run build command before deploying. Only use this if you have no need for a build or your project has already been built.

public bool NoBuild { get; set; }

Property Value

bool

Open

Open project after deploy.

public bool Open { get; set; }

Property Value

bool

Prod

Deploy to production.

public bool Prod { get; set; }

Property Value

bool

ProdIfUnlocked

Deploy to production if unlocked, create a draft otherwise.

public bool ProdIfUnlocked { get; set; }

Property Value

bool

Site

A project name or ID to deploy to.

public string? Site { get; set; }

Property Value

string

SkipFunctionsCache

Ignore any functions created as part of a previous build or deploy commands, forcing them to be bundled again as part of the deployment.

public bool SkipFunctionsCache { get; set; }

Property Value

bool

Team

Specify team slug when creating a site. Only works with CreateSite flag.

public string? Team { get; set; }

Property Value

string

Timeout

Timeout to wait for deployment to finish.

public string? Timeout { get; set; }

Property Value

string

Trigger

Trigger a new build of your project on Netlify without uploading local files.

public bool Trigger { get; set; }

Property Value

bool