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