Merge pull request #211 from f-actions/madig-fix-installs

Fix fontbakery installation and add support for fontbakery extras dependencies installation

.eslintrc.yml

@@ -1,11 +1,8 @@
-extends:
-  - wesbos
-
-parser: "babel-eslint"
-
-rules:
-  no-console:
-    - off
-  quotes: 0
-  prettier/prettier:
-    - singleQuote: false
+env:
+  es2021: true
+  node: true
+extends: eslint:recommended
+parserOptions:
+  ecmaVersion: latest
+  sourceType: module
+rules: {}

.github/workflows/action-ci.yaml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
     name: Action CI
     steps:
       - name: Check out source repository
@@ -20,6 +20,7 @@ jobs:
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
+          check-latest: true
       - name: Update dependencies
         run: python3 -m pip install --upgrade pip wheel setuptools
       - name: Python environment report
@@ -28,29 +29,29 @@ jobs:
         uses: f-actions/font-bakery@master
         with:
           subcmd: "--help"
-      - name: Action CI - default with single file
-        uses: f-actions/font-bakery@master
-        with:
-          subcmd: "check-profile"
-          args: "tests/check-test.py"
-          path: "tests/NotoSans-Regular.ttf"
-      - name: Action CI - default with wildcard path
-        uses: f-actions/font-bakery@master
-        with:
-          subcmd: "check-profile"
-          args: "tests/check-test.py"
-          path: "tests/*.ttf"
-      - name: Action CI - fontbakery main branch version
-        uses: f-actions/font-bakery@master
-        with:
-          subcmd: "check-profile"
-          args: "tests/check-test.py"
-          path: "tests/*.ttf"
-          version: "main"
-      - name: Action CI - fontbakery pinned release version
-        uses: f-actions/font-bakery@master
-        with:
-          subcmd: "check-profile"
-          args: "tests/check-test.py"
-          path: "tests/*.ttf"
-          version: "0.7.25"
+      # - name: Action CI - default with single file
+      #   uses: f-actions/font-bakery@master
+      #   with:
+      #     subcmd: "check-profile"
+      #     args: "tests/check-test.py"
+      #     path: "tests/NotoSans-Regular.ttf"
+      # - name: Action CI - default with wildcard path
+      #   uses: f-actions/font-bakery@master
+      #   with:
+      #     subcmd: "check-profile"
+      #     args: "tests/check-test.py"
+      #     path: "tests/*.ttf"
+      # - name: Action CI - fontbakery main branch version
+      #   uses: f-actions/font-bakery@master
+      #   with:
+      #     subcmd: "check-profile"
+      #     args: "tests/check-test.py"
+      #     path: "tests/*.ttf"
+      #     version: "main"
+      # - name: Action CI - fontbakery pinned release version
+      #   uses: f-actions/font-bakery@master
+      #   with:
+      #     subcmd: "check-profile"
+      #     args: "tests/check-test.py"
+      #     path: "tests/*.ttf"
+      #     version: "0.7.25"

.github/workflows/eslint.yaml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: ["12"]
+        node: ["18"]
     name: Node ${{ matrix.node }} eslint run
     steps:
       - uses: actions/checkout@v3

.gitignore

@@ -1,2 +1,3 @@
 node_modules
 *.pyc
+.vscode

CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## v3.0.0
+
+- [Backwards incompatible with fontbakery < v0.9.0] added default support for the fontbakery all extras dependencies installation at fontbakery install
+- [Backwards incomaptible with f-actions/font-bakery@v2 and earlier] Made the `path` font path input mandatory and removed the default definition if this is not defined
+- removed a number of unnecessary node dev depependencies
+- revised the eslint configuration on the JS source lints
+- updated estlint CI testing to use a node20 environment (from node16 which is deprecated)
+- updated Makefile dev-update target to use the updated npm option definition approach to developer dependency updates
+- updated Makefile dist target to include `--legacy-peer-deps` and `NODE_OPTIONS=--openssl-legacy-provider` options at distribution JS file build time
+- updated the README link to the fontbakery project which has moved to the fonttools org from the googlefonts org since our last release here
+
 ## v2.0.0
 
 - change `version` configuration input field "master" definition to "main" (**Note**: backwards incompatible change for users who were previous users of the "master" definition)

Makefile

@@ -1,11 +1,11 @@
 dist: src/*.js package*.json
-	npm i && npm run package
+	npm i --legacy-peer-deps && NODE_OPTIONS=--openssl-legacy-provider npm run package
 
 update:
 	npm update
 
 dev-update:
-	npm update --dev
+	npm update --include=dev
 
 lint:
 	npm run lint

README.md

@@ -4,7 +4,7 @@
 [![Action CI](https://github.com/f-actions/font-bakery/workflows/Action%20CI/badge.svg)](https://github.com/f-actions/font-bakery/actions?query=workflow%3A%22Action+CI%22)
 [![Lint](https://github.com/f-actions/font-bakery/workflows/Lint/badge.svg)](https://github.com/f-actions/font-bakery/actions?query=workflow%3ALint)
 
-This GitHub Action installs the [googlefonts/fontbakery](https://github.com/googlefonts/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.6+ runner environment.
+This GitHub Action installs the [googlefonts/fontbakery](https://github.com/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.
 
 ## Quick Start
 
@@ -33,17 +33,17 @@ jobs:
       - name: Build fonts
         run: make  # enter your build shell commands here
       - name: fontbakery TTF checks
-        uses: f-actions/font-bakery@v2
+        uses: f-actions/font-bakery@v3
         with:
           subcmd: "check-universal"  # fontbakery sub-command
-          args: "--loglevel WARN"  # optional arguments to fontbakery
+          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@v2
+        uses: f-actions/font-bakery@v3
         with:
           subcmd: "check-universal"  # fontbakery sub-command
-          args: "--loglevel WARN"  # optional arguments to fontbakery
+          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
 ```
@@ -66,7 +66,7 @@ args: "--loglevel WARN"
 
 ### `path`
 
-**Optional** The path to the font file(s).  You may use wildcards in this path definition. Default: `build` directory
+**Mandatory** The path to the font file(s).  You may use wildcards in this path definition.
 
  ```
 path: "path/to/*.ttf"
@@ -84,6 +84,8 @@ subcmd: "check-universal"
 
 ### `version`
 
+**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.

action.yml

@@ -3,8 +3,7 @@ description: "Font Bakery QA testing"
 inputs:
   path: # id
     description: "Path to build artifact testing directory"
-    required: false
-    default: "build"
+    required: true
   subcmd: # id
     description: "Font Bakery subcommand"
     required: true
@@ -18,7 +17,7 @@ inputs:
     default: "latest"
 
 runs:
-  using: "node16"
+  using: "node20"
   main: "dist/index.js"
 
 branding: