发行说明生成器包
JustReleaseNotes的Python项目详细描述
只需发布说明
该工具提供了一种自定义生成发行说明过程的方法，其基础是：
- 在提交消息中发出跟踪标识符
- 提交时的标记
- 发布工件库
运行工具
用法
要运行该工具，请致电：
& just_release --config <config.json> notes
配置
配置文件处于流动状态。现在它是一个json，看起来像这样：
{
"pathToSave" : <output path>,
"packages" : {
<package name> : {
"Issues" : [{
"Provider" : <issues provider>,
"HtmlUrl" : ...,
"Authorization" : ...,
"Url" : ...,
"WebImagesPath" : ...,
"TicketRegex" : ...
}],
"Releases" : {
"Provider" : <releases provider>,
"Repository" : ...,
"ArtifactUri" : ...,
"StorageUrl" : ...
},
"Source" : {
"Provider" : <source provider>,
"RepositoryUrl" : ...,
"Remote" : ...,
"Branch" : ...,
"VersionTagRegex" : "^([0-9]+\\.[0-9]+\\.[0-9]+)$",
"OldestCommitToProcess" : <commit hexsha>,
"ExcludeCommitsWithMessageMatchingRegex" : <regex>
},
"ReleaseNotesWriter" : [{
"Provider" : <notes writer provider>
"PathToSave" : ...
}]
}
}
}
其中
notes writer provider是：
- htmlwriter
- MarkdownWriter
- GithubMarkdownWriter
- StashMarkdownWriter
- jsonwriter
releases provider是：
- 手工艺品
- githubreleases
issues provider是：
- 集市
- githubissues
还可以指定问题提供程序的数组，然后所有这些提供程序都将用于检索有关票证的信息。
source provider当前仅为：
- 吉特回购
您还可以使用以下语法使用环境变量：
{
...
"key" : "aaa ENV[xxx] bbb"
...
}
在上面的示例中，env[xxx]将替换为'xxx'变量的值
欢迎加入QQ群-->： 979659372
