私(Gakuto1112)のFiguraアバターのREADMEに含まれる共通の文章をテンプレート化するレポジトリです。
templates/
に英語版と日本語版の各種README用のテンプレートがあります。
それぞれのFiguraアバターのレポジトリでREADMEが変更されると、Github Actionsによって、このレポジトリのテンプレートを使用して表示用のREADMEを生成します。
READMEのテンプレートが変更されると、Github Actionsによって、対象の全レポジトリと対象の全ブランチのREADMEを生成します。
対象のレポジトリには.github/README_templates
配下に生成するREADMEの素になるファイルがあります。これらのファイル内に<!-- $inject(<テンプレート名>) -->
と入力することで、この場所がテンプレートに置換されます。テンプレート名については下のテンプレートファイルについてを確認して下さい。
templates/
に各種テンプレート用のマークダウンファイルがあります。templates/
配下はテンプレート名のディレクトリがあります。更にそれらの配下に英語版のテンプレート(en.md
)と日本語版のテンプレート(jp.md
)があります。
現在このレポジトリにあるテンプレートは以下の通りです。
テンプレート名 | 内容 |
---|---|
locale_link | 言語切り替えリンク |
how_to_use | 使用方法の章 |
notes | 注意事項の章 |
各テンプレートには、レポジトリ名が入るプレースホルダ(<!-- $REPOSITORY_NAME -->
)がありますが、ここにはGithub Actionsによって実際の値が代入されます。
.github/workflows
にGithub Actionsワークフローの定義ファイルがあります。
FiguraアバターのREADMEが変更された時(push
)にこのワークフローが呼ばれ(workflow_call
)、READMEが生成されます。
必須、string
READMEを生成する対象のブランチ名
このレポジトリのテンプレートが変更された時(push
)に対象のFiguraレポジトリに対してワークフローを実行させます(repository_dispatch
)。
レポジトリ変数のTARGET_REPOSITORIES
に呼び出し対象のレポジトリ名が配列で定義されています。また、レポジトリシークレットのDISPATCH_TOKEN
にこのワークフローを実行する為のPersonal Access Tokenが定義されています。
(改良されたワークフローでは手順4が不要となります。)
- アバターのレポジトリに
.github
を作成する。 .github/README_templates
にja.md
(日本語版README)とen.md
(英語版README)を作成する。これらのファイルにREADMEを記述する。テンプレートの挿入方法も参照する。.github/workflows
にgenerate_readme.yml
とdispatch_readme.yml
を追加する。これらのファイルは既存のアバターのレポジトリからコピーする。- レポジトリの変数に
TARGET_BRANCHES
という名前でREADMEを生成する対象のブランチの配列を定義する(例:["Senko", "Shiro", "Suzu"]
)。 - このレポジトリの変数
TARGET_REPOSITORIES
に新規アバターのレポジトリを追加する。
(改良されたワークフローでは手順2及び3が不要となります。)
- 増やしたアバターのブランチにも
.github
の中身を追加する。 .github/workflows/generate_readme.yml
のon
->push
->branches
に増やしたアバターのブランチを追加する。- このレポジトリの変数
TARGET_BRANCHES
に増やしたアバターのブランチを追加する。