auto generate changelogダウンロード - auto generate changelogソースコードダウンロード

auto generate changelog

その他のソースコード

v1.2.5

ダウンロード

Auto-jenerate-changelog

従来のコミットに従ってChangelogを自動的に生成するための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の生成すべてのコミット履歴が必要なので、 actions/checkoutでfetch-depth: 0設定する必要があります
注： docs(changelog)またはdoc(CHANGELOG)で掲載されたログは、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`
suppress_unscoped	非参入コミットを除外するかどうか	いいえ	間違い
unreleased_commits	Changelogに未発表のコミットを含めるかどうか	いいえ	間違い
regenerate_count	再生n最近のリリースの変更ログ。メモ5を参照してください	いいえ	0
lated_empty_release_info	空のリリース情報をいくつかの単語に置き換えます	いいえ	間違い

注1 ： ${{secrets.GITHUB_TOKEN}}には、個人アクセストークン（pat）よりも小さいレート制限があるため、より多くのリクエスト（コミット、PRSなど）がある場合、または403レートリミットエラーに直面している場合は、代わりにPATを使用します。

注2 ： PULL_REQUEST BRANCHを一緒に使用する必要があります。プルリクエストを開く場合は、両方とも有効なブランチ名を提供する必要があります。 GAは、 BRANCH （ヘッドブランチ）からPULL_REQUEST （ベースブランチ）へのプルリクエストを開きます。 PULL_REQUESTブランクを残します。

注3 ：コミットメッセージから検出されたキーワードと、入力TYPEの変更ログで表示される対応する単語を定義できます。たとえば、 feat:Feature,fix:Bug Fixesにはfeat(main): add new option Feature fix(server): adjust renderingなどのコミットBug Fixesがあります。

注4 ： COMMITTER形式である必要があります： 'author <author@email>'

ノート5 ：Changelogに存在しないすべてのリリースは、もちろんChangelogに追加されます。このパラメーターを使用して、最後のnリリースの変更ログを再生します。デフォルト設定0は、新しいリリースに対してのみ生成されることを意味します。すべてのリリースを再生するために-1に設定できます。

メモ6 ：以下の形式を使用して、リリースの説明のいくつかの行を避けて、変更ログに表示できます。

 <!-- 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