-
Notifications
You must be signed in to change notification settings - Fork 156
Add comprehensive documentation for ExecutableResource and AddExecutable API #4188
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.
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
base: main
Are you sure you want to change the base?
Conversation
Co-authored-by: IEvangelist <[email protected]>
ExecutableResource
- Host non-.NET applications that don't have containerized equivalents | ||
- Integrate command-line tools or utilities into your application | ||
- Run external processes that other resources depend on | ||
- Develop with tools that provide local development servers |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why do you always mistakenly not account for the .github/copilot-instructions.md file? You're supposed to use complete sentences and proper punctuation for lists.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed the list formatting by adding proper punctuation (periods) to complete sentences as specified in the .github/copilot-instructions.md file.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Was this done for the entire document, or just the single section I commented on. It needs to apply to all MD files you create.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Applied the punctuation fix to the entire document. All lists containing complete sentences now have proper periods, including the method parameters section (lines 48-51) and the best practices section (lines 265-270). Commit e6c968e.
…zure SWA CLI with Vercel CLI Co-authored-by: IEvangelist <[email protected]>
…cument Co-authored-by: IEvangelist <[email protected]>
This PR adds a new comprehensive article documenting how to use
ExecutableResource
and theAddExecutable
extension method in .NET Aspire app hosts. The documentation was missing entirely, leaving developers without guidance on how to host external executable applications.What's included
The new article
docs/app-host/executable-resources.md
covers:AddExecutable
with command-line arguments and working directoriesWithArgs
, direct parameters)WithResource
calls and environment variable accessPublishAsDockerfile
for deploymentKey examples
The article includes practical examples for common scenarios:
The documentation addresses the specific use case mentioned in the issue (external executable hosting) while providing comprehensive coverage for any external executable scenario using modern tooling like Vercel CLI.
Fixes #1381.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.
Internal previews