Documentation
¶
Overview ¶
Package document 负责 release-note 文档、来源链接和 PR 声明的解析校验。
Index ¶
- func ChangelogCompareLabel(version, previous string) string
- func ChangelogCompareLink(version, previous string) string
- func IsReleaseNoteCategory(category string) bool
- func IsSemanticVersion(version string) bool
- func ParseReleaseNoteDeclaration(body string) (model.ReleaseNote, error)
- func ReadAuditReport(path string) (model.AuditReport, error)
- func RecommendedVersionBump(notes []model.ReleaseNote) string
- func RenderGitHubReleaseBody(directory, version string) (string, error)
- func RenderPreparedReleaseDocument(config model.PrepareConfig, plan model.PreparePlan, chinese bool) ([]byte, error)
- func RenderSourceLink(source string) (string, error)
- func RunRender(arguments []string) error
- func RunValidate(arguments []string) error
- func UpdateChangelogIndex(path, version, previous, date string, replace bool) ([]byte, error)
- func ValidateReleaseDirectory(directory, version, previous string) error
- func ValidateSourceCoverage(directory, version, previous string, report model.AuditReport) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ChangelogCompareLabel ¶
ChangelogCompareLabel 返回版本说明底部的比较链接文字。
func ChangelogCompareLink ¶
ChangelogCompareLink 返回版本说明底部的比较链接。
func IsReleaseNoteCategory ¶
IsReleaseNoteCategory 判断 PR 声明中的 category 是否受支持。
func IsSemanticVersion ¶
IsSemanticVersion 判断不带 v 前缀的版本字符串是否符合 release-note 契约。
func ParseReleaseNoteDeclaration ¶
func ParseReleaseNoteDeclaration(body string) (model.ReleaseNote, error)
ParseReleaseNoteDeclaration 读取 PR 正文中的机器可读注释。 注释不直接显示在 GitHub 页面上，便于 CI 在离线事件载荷中稳定校验。
func ReadAuditReport ¶
func ReadAuditReport(path string) (model.AuditReport, error)
ReadAuditReport 读取 prepare/validate 共用的 audit JSON 报告。
func RecommendedVersionBump ¶
func RecommendedVersionBump(notes []model.ReleaseNote) string
RecommendedVersionBump 根据 release-note 声明计算建议的版本级别。
func RenderGitHubReleaseBody ¶
RenderGitHubReleaseBody 从双语 changelog 生成稳定的 GitHub Release 正文。
func RenderPreparedReleaseDocument ¶
func RenderPreparedReleaseDocument(config model.PrepareConfig, plan model.PreparePlan, chinese bool) ([]byte, error)
RenderPreparedReleaseDocument 将审核后的计划渲染为一份双语版本说明。
func RenderSourceLink ¶
RenderSourceLink 将受支持的 PR/commit URL 转为稳定的 changelog 链接。
func UpdateChangelogIndex ¶
UpdateChangelogIndex 在 Unreleased 行之后插入版本索引行。
func ValidateReleaseDirectory ¶
ValidateReleaseDirectory 检查可发布的双语版本文件。
func ValidateSourceCoverage ¶
func ValidateSourceCoverage(directory, version, previous string, report model.AuditReport) error
ValidateSourceCoverage 将已渲染的说明与审计报告逐项对照。
Types ¶
This section is empty.
Source Files