auto generate changelog下载 - auto generate changelog源代码下载

auto generate changelog

其他源码

v1.2.5

下载

自动生成更换

根据常规提交会自动生成更改的gitHub动作。

随时提交拉动请求或问题，但请确保遵循模板。

欢迎贡献者一起改进这个项目！

如果您喜欢这样，请给我一颗星星！

用法

创建一个工作流量文件，例如.github/workflows/changelog.yml （您可以在此回购中找到它）

 name : Generate changelog
on :
  release :
    types : [created, edited]

jobs :
  generate-changelog :
    runs-on : ubuntu-latest
    steps :
    - uses : actions/checkout@v2
      with :
        fetch-depth : 0
    - uses : BobAnkh/[email protected]
      with :
        REPO_NAME : ' <YourUserName>/<YourRepoName> '
        ACCESS_TOKEN : ${{secrets.GITHUB_TOKEN}}
        PATH : ' CHANGELOG.md '
        COMMIT_MESSAGE : ' docs(CHANGELOG): update release notes '
        TYPE : ' feat:Feature,fix:Bug Fixes,docs:Documentation,refactor:Refactor,perf:Performance Improvements '

注意：生成ChangElog需要所有提交历史记录，因此您应该设置fetch-depth: 0使用actions/checkout
注意：提交日志以docs(changelog)或doc(CHANGELOG)的形式开头

输入

请参阅表下方的注释，了解如何设置一些参数。

输入	描述	必需的	默认
repo_name	存储库名称	不	`''`这意味着当前的存储库
Access_Token	github访问令牌。参见注释1	是的	您只需通过`${{secrets.GITHUB_TOKEN}}`
小路	您文件的路径	不	`CHANGELOG.md`
分支	路径中指定的文件的分支	不	`''`这意味着默认分支
pull_request	如果设置为目标分支名称，请打开新的拉请请求。参见注释2	不	`''`这意味着默认情况下不打开拉的请求
commit_message	提交消息	不	`docs(CHANGELOG): update release notes`
类型	您要添加到ChangElog的投入类型。参见注释3	不	`'feat:Feature,fix:Fix'`
参数	您要用来更新文件的参数。参见注释4	不	`''`这意味着默认委员会
default_scope	默认范围保存所有未指示的提交	不	`general`
uspress_unscoped	是否排除未指示的提交	不	错误的
未释放的_commits	是否将未发行的提交包含在Changelog中	不	错误的
再生_COUNT	再生n最近的发行版本。参见注释5	不	0
replace_empty_release_info	用一些单词替换空的发布信息	不	错误的

注释1 ： ${{secrets.GITHUB_TOKEN}}的利率限制小于个人访问令牌（PAT），因此，如果您有更多的请求（提交，PRS等）或面对403 rate rimit-rimit-error，请改用PAT。

注释2 ：必须将PULL_REQUEST与BRANCH一起使用，如果要打开拉动请求，则应为两者提供有效的分支名称。 GA将打开从BRANCH （头部分支）到PULL_REQUEST （基本分支）的拉动请求。如果您不想打开拉动请求，请留下PULL_REQUEST空白。

注释3 ：您可以定义从提交消息中检测到的关键字和输入TYPE中的changelog中介绍的相应单词。例如，定义feat:Feature,fix:Bug Fixes将具有提交消息（例如feat(main): add new option零件Feature下的新的选项，并在part Bug Fixes下在shangeLog中呈现的fix(server): adjust rendering等提交消息。

注释4 ： COMMITTER应采用格式： 'author <author@email>'

注释5 ：当然，所有版本都不存在于ChangElog中。使用此参数重新生成最后的N发行的ChangElog。默认设置为0表示仅生成新版本。您可以设置为-1以再生所有发行版。

注释6 ：您可以使用以下格式来避免发行说明中的某些行以出现在ChangElog中：

 <!-- HIDE IN CHANGELOG BEGIN -->
See CHANGELOG for more details. This line will be hided when changelog is generated.
<!-- HIDE IN CHANGELOG END -->

维护者

@bobankh

如何贡献

您应该遵循我们的行为准则。

请参阅有关贡献惯例的贡献指南。

在提交代码之前，请确保通过所有测试。您可以在根目录处进行pytest -ra以进行所有测试。

您可以在本地计算机上开发本地模式，这是命令行的帮助信息：

 usage: main.py [-h] [-m MODE] [-f FILE] [-o OUTPUT] [-t TOKEN]

optional arguments:
  -h, --help            show this help message and exit
  -m MODE, --mode MODE  choose to use local-dev mode or on github action mode.
                        Valid values are 'local' or 'github'
  -f FILE, --file FILE  configuration file to read from when running local-dev
                        mode
  -o OUTPUT, --output OUTPUT
                        output file when running local-dev mode
  -t TOKEN, --token TOKEN
                        Github Access Token