公共 API 索引
在选定工作流后,用这一节按名称和源码查找成员。生成页列出公开类型、属性和方法名称及其源文件;它不是完整的 API 参考文档,不复现完整 C# 签名,也不再讲一遍使用流程。
参考页由当前源码分支生成,可能与已发布的 NuGet 包不同。应用需要固定版本时,请以该包版本的更新日志和源码为准。
先看包指南
| 包 | 人工指南 | 生成参考 |
|---|---|---|
HelmSharp.Action | 包指南 | API |
HelmSharp.Chart | 包指南 | API |
HelmSharp.Engine | 包指南 | API |
HelmSharp.Kube | 包指南 | API |
HelmSharp.Release | 包指南 | API |
HelmSharp.Repo | 包指南 | API |
HelmSharp.Registry | 包指南 | API |
HelmSharp.Storage | 包指南 | API |
HelmSharp.PostRenderer | 包指南 | API |
建议的阅读顺序
- 先通过包和 API 选择确认这一层抽象适合放入应用。
- 在生成页中查找成员或属性名称及其源码位置;类型、参数和返回值请打开对应源码声明查看。
- 成员会变更集群状态、values 优先级或兼容性行为时,回到对应指南或示例阅读。
模板函数 API
HelmSharp.Engine.Functions 和 HelmSharp.Engine.Utilities 下的类型会出现在 Engine 参考中,但它们主要服务 Helm/Sprig 模板执行。应用代码通常应调用 HelmTemplateRenderer,而不是直接依赖这些辅助类型。
公开 API 变更后重新生成
powershell
pwsh docs/scripts/generate-api-reference.ps1