diff --git a/Directory.Build.props b/Directory.Build.props index b4e9df32..1e8e5281 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -17,5 +17,10 @@ false true true - + + + + false + true + diff --git a/docs/create-integration.md b/docs/create-integration.md index b3fac427..976f768b 100644 --- a/docs/create-integration.md +++ b/docs/create-integration.md @@ -39,6 +39,7 @@ To create a new integration, you'll need to create a new project in the `src/` d To improve discovery of the integration when someone consumes the NuGet package, extension methods for adding the integration should be placed in the `Aspire.Hosting` for hosting integrations or `Microsoft.Extensions.Hosting` for client integrations. For custom resources created in hosting integrations, use the `Aspire.Hosting.ApplicationModel` namespace. If your integration will be pulling a container image from a registry, you should specify a specific tag for the image in a `major.minor` format to pull, and not use the `latest` tag. This will ensure that the integration is stable and not affected by changes to the image. If the image is not versioned, you should use the `sha256` digest of the image. + ## 🪧 Example application To demonstrate how to use the integration, you should create an example application in the `examples/` directory. This should be a simple application that demonstrates the minimal usage of the integration. At minimum there will need to be an AppHost project which uses the integration. This example application will also be used in the integration tests if it's a hosting integration. @@ -120,7 +121,22 @@ Lastly, update the `README.md` in the root of this repository to include your ne Your integration will be automatically packaged as a NuGet package when a PR is created and added as an artifact to the CI job (assuming it builds!), allowing you to test it in other projects while it is being reviewed. Once reviewed it will move through the release workflow that the maintainers have set up. You can learn more about that in the [versioning documentation](./versioning.md). +### 💡 NuGet Package metadata + +Most of the NuGet metadata will be automatically added to the generated nuspec file during the packaging process in the CI pipeline but there are two pieces of metadata that you will need to add manually to the csproj file for your integration: + +- `Description` - A short description of the integration. +- `AdditionalTags` - A comma-separated list of tags that describe the integration (some tags are added by default, such as `aspire`, use this to add more specific tags for your integration). + +Here's an example from the OllamaSharp integration: + +```xml + + A .NET Aspire client integration for the OllamaSharp library. + ollama ai ollamasharp + +``` + ## 🎉 You're done That's it! You've created a new integration for the .NET Aspire Community Toolkit. If you have any questions or need help, feel free to reach out to the maintainers or the community on GitHub Discussions. - diff --git a/src/Aspire.CommunityToolkit.Hosting.Azure.StaticWebApps/Aspire.CommunityToolkit.Hosting.Azure.StaticWebApps.csproj b/src/Aspire.CommunityToolkit.Hosting.Azure.StaticWebApps/Aspire.CommunityToolkit.Hosting.Azure.StaticWebApps.csproj index 44a92b97..282b933e 100644 --- a/src/Aspire.CommunityToolkit.Hosting.Azure.StaticWebApps/Aspire.CommunityToolkit.Hosting.Azure.StaticWebApps.csproj +++ b/src/Aspire.CommunityToolkit.Hosting.Azure.StaticWebApps/Aspire.CommunityToolkit.Hosting.Azure.StaticWebApps.csproj @@ -1,5 +1,6 @@  azure staticwebapps hosting + A hosting package that wraps endpoints with the Azure Static Web Apps emulator. diff --git a/src/Aspire.CommunityToolkit.Hosting.Golang/Aspire.CommunityToolkit.Hosting.Golang.csproj b/src/Aspire.CommunityToolkit.Hosting.Golang/Aspire.CommunityToolkit.Hosting.Golang.csproj index e63e701a..ff323a07 100644 --- a/src/Aspire.CommunityToolkit.Hosting.Golang/Aspire.CommunityToolkit.Hosting.Golang.csproj +++ b/src/Aspire.CommunityToolkit.Hosting.Golang/Aspire.CommunityToolkit.Hosting.Golang.csproj @@ -1,5 +1,6 @@  hosting golang + A .NET Aspire for hosting Golang apps. diff --git a/src/Aspire.CommunityToolkit.Hosting.Java/Aspire.CommunityToolkit.Hosting.Java.csproj b/src/Aspire.CommunityToolkit.Hosting.Java/Aspire.CommunityToolkit.Hosting.Java.csproj index 132c5914..76f46094 100644 --- a/src/Aspire.CommunityToolkit.Hosting.Java/Aspire.CommunityToolkit.Hosting.Java.csproj +++ b/src/Aspire.CommunityToolkit.Hosting.Java/Aspire.CommunityToolkit.Hosting.Java.csproj @@ -1,5 +1,6 @@  hosting java + A .NET Aspire for hosting Java apps using either the Java executable or container image. diff --git a/src/Aspire.CommunityToolkit.Hosting.NodeJS.Extensions/Aspire.CommunityToolkit.Hosting.NodeJS.Extensions.csproj b/src/Aspire.CommunityToolkit.Hosting.NodeJS.Extensions/Aspire.CommunityToolkit.Hosting.NodeJS.Extensions.csproj index 475ca27a..6ec734c0 100644 --- a/src/Aspire.CommunityToolkit.Hosting.NodeJS.Extensions/Aspire.CommunityToolkit.Hosting.NodeJS.Extensions.csproj +++ b/src/Aspire.CommunityToolkit.Hosting.NodeJS.Extensions/Aspire.CommunityToolkit.Hosting.NodeJS.Extensions.csproj @@ -2,6 +2,7 @@ hosting nodejs vite yarn pnpm npm + A .NET Aspire for hosting NodeJS apps using Vite, Yarn, PNPM, or NPM. diff --git a/src/Aspire.CommunityToolkit.OllamaSharp/Aspire.CommunityToolkit.OllamaSharp.csproj b/src/Aspire.CommunityToolkit.OllamaSharp/Aspire.CommunityToolkit.OllamaSharp.csproj index 3b420439..8bd8e431 100644 --- a/src/Aspire.CommunityToolkit.OllamaSharp/Aspire.CommunityToolkit.OllamaSharp.csproj +++ b/src/Aspire.CommunityToolkit.OllamaSharp/Aspire.CommunityToolkit.OllamaSharp.csproj @@ -1,11 +1,5 @@  - - net8.0 - enable - enable - - A .NET Aspire client integration for the OllamaSharp library. ollama ai ollamasharp diff --git a/src/Directory.Build.props b/src/Directory.Build.props index 2ff1ed2b..6f74419e 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -22,6 +22,7 @@ true README.md + $(DocsPath) ../../nuget aspire integration communitytoolkit dotnetcommunitytoolkit $(AdditionalPackageTags) @@ -47,4 +48,13 @@ / + + + + <_VersionSuffix>$([System.DateTime]::Now.ToString(yyMMdd-HHmm)) + dev.$(_VersionSuffix) + $(VersionPrefix)-$(VersionSuffix) + \ No newline at end of file