Skip to content

Fix capitalization of PublishAsDockerFile method #562

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.

Sign up for GitHub

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

Merged
IEvangelist merged 1 commit into from
Mar 19, 2026
Merged

Fix capitalization of PublishAsDockerFile method #562

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions src/frontend/src/content/docs/app-host/executable-resources.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,19 +146,19 @@ var app = builder.AddExecutable(
});
```

## Publishing with PublishAsDockerfile
## Publishing with PublishAsDockerFile

For production deployment, executable resources need to be containerized. Use the `PublishAsDockerfile` method to specify how the executable should be packaged:
For production deployment, executable resources need to be containerized. Use the `PublishAsDockerFile` method to specify how the executable should be packaged:

```csharp title="AppHost.cs"
var builder = DistributedApplication.CreateBuilder(args);

var app = builder.AddExecutable(
"frontend", "npm", ".", "start", "--port", "3000")
.PublishAsDockerfile();
.PublishAsDockerFile();
```

When you call `PublishAsDockerfile()`, Aspire generates a Dockerfile during the publish process. You can customize this by providing your own Dockerfile:
When you call `PublishAsDockerFile()`, Aspire generates a Dockerfile during the publish process. You can customize this by providing your own Dockerfile:

### Custom Dockerfile for publishing

Expand All @@ -180,7 +180,7 @@ Then reference it in your AppHost:
var builder = DistributedApplication.CreateBuilder(args);

var app = builder.AddExecutable("frontend", "npm", ".", "start")
.PublishAsDockerfile([new DockerfileBuildArg("NODE_ENV", "production")]);
.PublishAsDockerFile([new DockerfileBuildArg("NODE_ENV", "production")]);
```

## Best practices
Expand All @@ -192,8 +192,8 @@ When working with executable resources:
1. **Use explicit paths**: For better reliability, use full paths to executables when possible.
1. **Handle dependencies**: Use `WithReference` to establish proper dependency relationships.
1. **Configure explicit start**: Use `WithExplicitStart()` for executables that shouldn't start automatically.
1. **Prepare for deployment**: Always use `PublishAsDockerfile()` for production scenarios.
1. **Prepare for deployment**: Always use `PublishAsDockerFile()` for production scenarios.
1. **Environment isolation**: Use environment variables rather than command-line arguments for sensitive configuration.
1. **Resource naming**: Use descriptive names that clearly identify the executable's purpose.

</Steps>
</Steps>
Loading