font bakery

F-Actions/Schriftbahler-Github-Aktion

Diese GitHub-Aktion installiert das FontTools/Fontbakery-Typ-Projektqualitätssicherungsinstrument und führt das Tool auf einem benutzerdefinierten Filepath im Rahmen einer Remote-Pipeline für kontinuierliche Integrationstests aus. Die Aktion erfordert eine Python V3.8+ Läuferumgebung.

Schneller Start

Erstellen Sie eine YAML -formatierte GitHub -Aktionskonfigurationsdatei auf dem Verzeichnispfad .github/workflows in Ihrem Quell -Repository. Bitte überprüfen Sie die Dokumentation von GitHub -Aktionen für detaillierte Anweisungen zur Konfigurationsdateisyntax.

Bitte beachten Sie : Diese Schritte erfordern, dass die Schriftarten in Ihrem CI -Workflow eingebaut sind, bevor die Schritte für die Schreibbauer ausgeführt werden oder unter Git -Versionskontrolle stehen und auf einen Remote -Quell -Repository -Verzeichnispfad übertragen werden. Im folgenden Beispiel wird ein Makefile -basiertes Build angenommen, das das Standard -Make -Ziel verwendet. Passen Sie den Befehl Build mit dem Ansatz an, den Sie in Ihrem Projekt verwenden.

Beispiel Workflow

 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

Weitere Informationen zu Standardeingängen und optionalen Konfigurationseinstellungen finden Sie im Abschnitt "Inputs).

Eingänge

Konfigurieren Sie die Aktion mit den folgenden Einstellungen:

args

Optional die Nicht-Path-Argumente an den ausführbaren Unterkommando der Schriftart. Dies ist beispielsweise ein Ort, an dem die Protokollebene festgelegt werden kann. Die folgende Einstellung begrenzt die Berichterstattung auf logarithmische und höhere Warnstufen:

 args: "--loglevel WARN"

Weitere Informationen zu den verfügbaren Optionen finden Sie in der Schreibböcke.

path

Obligatorisch den Pfad zur Schriftart Datei (en). Sie können Wildcards in dieser Pfaddefinition verwenden.

 path: "path/to/*.ttf"

subcmd

Obligatorisch der Unterkommando der Schriftart. Dies gibt das Testprofil an, das auf Ihren Schriftarten ausgeführt wird.

 subcmd: "check-universal"

Weitere Details finden Sie fontbakery --help oder die Dokumentation der Schriftart.

version

Bitte beachten Sie : Wenn Sie die Installationen der Schriftart <v0.9.0 mit diesem Eingabefeld definieren, müssen Sie in der v2 -Filiale dieser GitHub -Aktion bleiben. Wir haben rückwärts inkompatible Änderungen eingeführt, die nicht mit der Installation von Schriftartenversionen <V.0.9.0 ab v3.0.0 Action veröffentlicht werden.

Optional Die Fontbakery -Version, die zum Testen verwendet werden sollte. Dies unterstützt PYPI -Releases und Direct Source Repository Master -Zweiginstallationen.

Standard: "letztes" = neueste PYPI Release -Version.

Optionen:

• "neuest" = neueste PYPI Release -Version (Dieser Ansatz stößt automatisch die Schriftversion mit neuen Veröffentlichungen an)
• "pre" = neueste PYPI Pre-Release-Version (Dieser Ansatz erhöht die Schriftversion automatisch mit neuen Vorablösungen)
• "Main" = Hauptbranch -Head Commit (Dieser Ansatz stößt die Schreibbahnen -Version automatisch mit neuen Commits, die in den Hauptzweig des Repository -Repositorys des Schreibbahnens gedrängt werden.
• "[Versionsnummer]" = PYPI Release -Versionsnummer, "0.7.28"

Ausgänge

Keiner

Lizenz

Apache -Lizenz, v2.0