Public API index
Use this section as a name and source index after choosing a workflow. The generated pages list public type, property, and method names with their source files; they are not complete API reference documentation and do not reproduce full C# signatures or teach a workflow a second time.
The reference is generated from the current source branch and can differ from a published NuGet package. For a version-pinned application, use that package version's release notes and source.
Start with the package guide
| Package | Curated guide | Generated reference |
|---|---|---|
HelmSharp.Action | Package guide | API |
HelmSharp.Chart | Package guide | API |
HelmSharp.Engine | Package guide | API |
HelmSharp.Kube | Package guide | API |
HelmSharp.Release | Package guide | API |
HelmSharp.Repo | Package guide | API |
HelmSharp.Registry | Package guide | API |
HelmSharp.Storage | Package guide | API |
HelmSharp.PostRenderer | Package guide | API |
Read a page in this order
- Start with a package guide to confirm the abstraction belongs in your application.
- Use the generated page to find a member or property name and its source location; open the source declaration for types, parameters, and return values.
- Return to a guide or example when a member changes cluster state, values precedence, or compatibility behavior.
Template function APIs
Types under HelmSharp.Engine.Functions and HelmSharp.Engine.Utilities are documented as part of the engine reference, but they primarily support Helm/Sprig template execution. Application code should normally call HelmTemplateRenderer, not those helper functions directly.
Regenerate after public API changes
powershell
pwsh docs/scripts/generate-api-reference.ps1