このGitHubアクションは、Fonttools/Fontbakery Thipface Project Assurance Toolをインストールし、リモート連続統合テストパイプラインの一部としてユーザー指定のFilePathでツールを実行します。このアクションには、Python V3.8+ランナー環境が必要です。
ソースリポジトリにディレクトリパス.github/workflowsにyamlフォーマットされたgithubアクション構成ファイルを作成します。構成ファイルの構文に関する詳細な手順については、GitHubアクションドキュメントを確認してください。
注:これらの手順では、フォントベーカリーのテスト手順が実行されるか、 GITバージョン制御下にあり、リモートソースリポジトリディレクトリパスにプッシュされる前に、フォントがCIワークフローに組み込まれている必要があります。以下の例は、デフォルトのMake Targetを使用するMakeFileベースのビルドを想定しています。プロジェクトで使用するアプローチでビルドコマンドをカスタマイズします。
name : Font Bakery QA Tests
on : [push, pull_request]
jobs :
fontbakery :
runs-on : ubuntu-latest
name : Font Bakery QA tests # Customize to edit the string in your GitHub CI UI
steps :
- name : Check out source repository
uses : actions/checkout@v3
- name : Set up Python environment
uses : actions/setup-python@v4
with :
python-version : " 3.11 " # supports any Py3.6+ version available in Actions
- name : Build fonts
run : make # enter your build shell commands here
- name : fontbakery TTF checks
uses : f-actions/font-bakery@v3
with :
subcmd : " check-universal " # fontbakery sub-command
args : " --loglevel WARN " # optional, arguments to fontbakery
path : " path/to/*.ttf " # font path relative to root of repository
version : " latest " # optional, latest PyPI release is default
- name : fontbakery OTF checks
uses : f-actions/font-bakery@v3
with :
subcmd : " check-universal " # fontbakery sub-command
args : " --loglevel WARN " # optional, arguments to fontbakery
path : " path/to/*.otf " # font path relative to root of repository
version : " latest " # optional, latest PyPI release is defaultデフォルトの入力とオプションの構成設定の詳細については、以下の入力セクションを参照してください。
次の設定でアクションを構成します。
argsフォントベーカリー実行可能サブコマンドに対する非パス引数。たとえば、これはログレベルを設定できる場所です。以下の設定は、警告以下のログレベルへの報告を制限します。
args: "--loglevel WARN"
利用可能なオプションの詳細については、FontBakeryヘルプメニューを参照してください。
pathフォントファイルへのパスを必須。このパス定義でワイルドカードを使用できます。
path: "path/to/*.ttf"
subcmdfontbakeryサブコマンドに必須。これは、フォントで実行されるテストプロファイルを指定します。
subcmd: "check-universal"
詳細については、 fontbakery --helpまたはFontbakeryドキュメントを参照してください。
version注:この入力フィールドを使用してfontbakery <v0.9.0のインストールを定義する場合は、このgithubアクションのv2ブランチに留まる必要があります。 v3.0.0アクションリリースの時点で、FontBakeryバージョン<v.0.9.0のインストールでは機能しない逆互換性のない変更を導入しました。
オプションテストに使用する必要があるFontBakeryバージョン。これにより、PYPIリリースと直接ソースリポジトリマスターブランチのインストールがサポートされます。
デフォルト:「最新」=最新のPYPIリリースバージョン。
オプション:
"0.7.28" (このアプローチはリリースバージョン番号でフォントベーカリーパッケージをピンします) なし
Apacheライセンス、v2.0