This GitHub Action installs the fonttools/fontbakery typeface project quality assurance tool and executes the tool on a user-specified filepath as part of a remote continuous integration testing pipeline. The Action requires a Python v3.8+ runner environment.
Create a yaml formatted GitHub Actions configuration file on the directory path .github/workflows in your source repository. Please review the GitHub Actions documentation for detailed instructions on the configuation file syntax.
Please note: These steps require that the fonts are built in your CI workflow before the fontbakery testing steps are executed or are under git version control and pushed to a remote source repository directory path. The example below assumes a Makefile based build that uses the default make target. Customize the build command with the approach that you use in your project.
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 defaultSee the Inputs section below for details on default inputs and optional configuration settings.
Configure the Action with the following settings:
Optional The non-path arguments to the fontbakery executable sub-command. For example, this is a location where the log level may be set. The setting below limits reporting to log levels of WARN and higher:
args: "--loglevel WARN"
See the fontbakery help menus for details on available options.
Mandatory The path to the font file(s). You may use wildcards in this path definition.
path: "path/to/*.ttf"
Mandatory The fontbakery sub-command. This specifies the test profile that is executed on your fonts.
subcmd: "check-universal"
See fontbakery --help or the fontbakery documentation for additional details.
Please note: If you define installations of fontbakery < v0.9.0 with this input field, you must remain on the v2 branch of this GitHub Action. We introduced backwards incompatible changes that will not work with the installation of fontbakery versions < v.0.9.0 as of the v3.0.0 Action release.
Optional The fontbakery version that should be used for testing. This supports PyPI releases and direct source repository master branch installations.
Default: "latest" = latest PyPI release version.
Options:
- "latest" = latest PyPI release version (this approach will automatically bump the fontbakery version with new releases)
- "pre" = latest PyPI pre-release version (this approach will automatically bump the fontbakery version with new pre-releases)
- "main" = main branch HEAD commit (this approach will automatically bump the fontbakery version with new commits that are pushed to the main branch of the fontbakery source repository)
- "[VERSION NUMBER]" = PyPI release version number, e.g.
"0.7.28"(this approach pins the fontbakery package at a release version number)
None