font bakery

Acción F-Actions/Font-Bakery GitHub

Esta acción de GitHub instala la herramienta de garantía de calidad del proyecto FontTools/FontBakery Tipokery y ejecuta la herramienta en un FilePath especificado por el usuario como parte de una tubería de prueba de integración continua remota. La acción requiere un entorno Python V3.8+ Runner.

Comienzo rápido

Cree un archivo de configuración de Acciones GitHub formateadas de YAML en la ruta del directorio .github/workflows en su repositorio de origen. Revise la documentación de las acciones de GitHub para obtener instrucciones detalladas sobre la sintaxis del archivo de configuración.

Tenga en cuenta : estos pasos requieren que las fuentes estén construidas en su flujo de trabajo CI antes de que los pasos de prueba de FontBakery se ejecuten o estén bajo control de versión GIT y se empujan a una ruta de directorio de repositorio de fuentes remotas. El siguiente ejemplo asume una compilación basada en el archivo que usa el objetivo de marca predeterminado. Personalice el comando de compilación con el enfoque que utiliza en su proyecto.

Ejemplo de flujo de trabajo

 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

Consulte la sección de entradas a continuación para obtener detalles sobre las entradas predeterminadas y la configuración de configuración opcional.

Entradas

Configure la acción con la siguiente configuración:

args

Opcional los argumentos que no son Path al subcomcomando ejecutable de FontBakery. Por ejemplo, esta es una ubicación donde se puede establecer el nivel de registro. La configuración a continuación limita el informe a los niveles de registro de advertencia y más alto:

 args: "--loglevel WARN"

Vea los menús de ayuda de FontBakery para obtener detalles sobre las opciones disponibles.

path

Obligatorio la ruta a los archivos de fuente. Puede usar comodines en esta definición de ruta.

 path: "path/to/*.ttf"

subcmd

Obligatorio el submand Fontbakery. Esto especifica el perfil de prueba que se ejecuta en sus fuentes.

 subcmd: "check-universal"

Consulte fontbakery --help o la documentación de FontBakery para obtener detalles adicionales.

version

Tenga en cuenta : si define las instalaciones de FontBakery <v0.9.0 con este campo de entrada, debe permanecer en la rama v2 de esta acción de GitHub. Introducimos cambios incompatibles al revés que no funcionarán con la instalación de versiones de FontBakery <v.0.9.0 a partir de la versión de acción v3.0.0 .

Opcional la versión de FontBakery que debe usarse para las pruebas. Esto admite las versiones de PYPI y las instalaciones de rama maestra del repositorio de fuentes directas.

Valor predeterminado: "Último" = última versión de lanzamiento de PYPI.

Opciones:

• "Último" = última versión de lanzamiento de PYPI (este enfoque aumentará automáticamente la versión de FontBakery con nuevos lanzamientos)
• "Pre" = Última versión de prelanzamiento de PYPI (este enfoque aumentará automáticamente la versión de FontBakery con nuevos prelactos)
• "Principal" = Conjunto de cabeza de rama principal (este enfoque aumentará automáticamente la versión de FontBakery con nuevos compromisos que se llevan a la rama principal del repositorio de fuente de Fontbakery)
• "[Número de versión]" = Número de versión de lanzamiento de Pypi, por ejemplo "0.7.28" (este enfoque fija el paquete FontBakery en un número de versión de versión)

Salidas

Ninguno

Licencia

Licencia Apache, v2.0