发布GitHub和GitLab的导出程序。
release-exporter的Python项目详细描述
博客:https://www.gollahalli.com/blog/export-your-github-and-gitlab-releases-as-a-changelog/
此cli将项目版本导出到基于keep a changelog和 markdownlint和json, 它目前支持github和gitlab。
安装
pip install release-exporter
或者下载此存储库并在 终端/命令
python setup.py install
用法
在终端/cmd中,切换到存储库所在的文件夹 定位并执行以下操作:
rex --token <your token> markdown
就这样。您应该在文件夹中看到CHANGELOG.md。
提前使用
Release Exporter有以下选项
Usage: rex [OPTIONS] COMMAND [ARGS]... Options: --token TEXT Token number if its a private repository. --url TEXT URL of your repository. This is optional if your current directory has .git folder with remote url. --location TEXT Local location of your repository. --version --help Show this message and exit. Commands: json Creates JSON file. markdown Creates markdown file. rest Creates reStructuredText file.
如果您的计算机上没有存储库,但仍要 生成更改日志您可以手动将存储库url添加为 如下:
rex markdown --token <your token> --url <your url>
如果您的存储库位于不同的位置,并且您很懒 (和我一样)若要切换到该目录,请获取 存储库将其添加到--location <location>。
rex --token <your token> --location <absolute path>
您还可以通过替换 markdown和json。输出如下:
{"repositoryName":"release-exporter","provider":"github.com","owner":"akshaybabloo","repoUrl":"https://github.com/akshaybabloo/release-exporter","totalTags":2,"data":[{"tagName":"Unreleased","description":"","createdAt":"","compareUrl":"https://github.com/akshaybabloo/release-exporter/compare/1.0.1...HEAD"},{"tagName":"v1.0.1","description":"### Added\n- Unreleased tag added to the template and GitHub\n- Unreleased tag added to GitHub\n\n### Fixed\n- Tag missing in GitHub JSON fixed\n- Tag missing in GitLab JSON fixed","createdAt":"2018-01-16","compareUrl":"https://github.com/akshaybabloo/release-exporter/compare/v1.0...v1.0.1"},{"tagName":"v1.0","description":"Initial release.","createdAt":"2018-01-15","compareUrl":null}]}
请注意,Unreleased标记不在totalTags中。
您可能遇到的问题
如果您正在存储库文件夹中使用rex,或者如果您正在使用 --location如果说存在重复项,则可能会出现错误 键,这是因为有时文件.git/config的 一个[remote "origin"]。在这种情况下,最好给出 通过给--url <repo URL>您的存储库。
定制输出
很快就来。