Skip to content

Fix Java/Spring hosting integration docs - add missing workingDirectory parameter and Linux/macOS certificate trust information #3710

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Jun 5, 2025

The .NET Aspire Java/Spring hosting integration documentation was missing critical information that prevented developers from successfully using the integration, particularly for executable hosting scenarios.

Issues Fixed

Missing required workingDirectory parameter

The executable hosting example was showing an incorrect API signature that would not compile:

// ❌ This doesn't work - missing workingDirectory parameter
var executableapp = builder.AddSpringApp(
    "executableapp",
    new JavaAppExecutableResourceOptions { ... });

Updated to show the correct signature:

// ✅ This works - includes required workingDirectory parameter
var executableapp = builder.AddSpringApp(
    "executableapp",
    workingDirectory: "../path/to/java/app",
    new JavaAppExecutableResourceOptions { ... });

Missing platform-specific certificate trust information

Added a new "Platform-specific considerations" section explaining that on Linux and macOS platforms, developers need to import the .NET Aspire OpenTelemetry certificate into the Java certificate store for telemetry to work properly. Without this step, applications start successfully but telemetry collection fails with certificate errors.

Enhanced parameter documentation

  • Added clear explanations for all parameters in both container and executable hosting modes
  • Marked required parameters explicitly (e.g., workingDirectory: (Required))
  • Provided better example values and explanations

Changes Made

  • ✅ Fixed executable hosting example to include required workingDirectory parameter
  • ✅ Added Linux/macOS certificate trust requirements section
  • ✅ Enhanced parameter documentation with clear explanations
  • ✅ Updated container hosting example with more realistic values
  • ✅ Updated ms.date to reflect current changes

These changes ensure the documentation matches the actual Community Toolkit API signatures and provides all the information developers need to successfully implement Java/Spring hosting integration.

Fixes #3673.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

…meter and Linux/macOS certificate trust information

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] .NET Aspire Java/Spring hosting integration docs are missing information Fix Java/Spring hosting integration docs - add missing workingDirectory parameter and Linux/macOS certificate trust information Jun 5, 2025
@Copilot Copilot AI requested a review from IEvangelist June 5, 2025 20:37
Copilot finished work on behalf of IEvangelist June 5, 2025 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

.NET Aspire Java/Spring hosting integration docs are missing information
2 participants