chore: add check engines script to CI

[lukekarrys]

This will test against regressions in (sub-)dependency engine changes and guard against breaking changes like #2848 #2873.

Errors will look like this:

Error: The following production dependencies are not compatible with `engines.node: ^14.17.0 || ^16.13.0 || >=18.0.0` found in `/home/runner/work/node-gyp/node-gyp/package.json`:
make-fetch-happen@13.0.0:
  engines.node: ^16.14.0 || >=18.0.0
  location: node_modules/make-fetch-happen
which@4.0.0:
  engines.node: ^16.13.0 || >=18.0.0
  location: node_modules/which

[DeeDeeG]

Adding this check seems like a good idea! (Given how it impacted users last time dependencies were bumped outside of the "advertised" supported versions of Node.)

I haven't read through all the code or anything, but I would approve of doing this, generally speaking!

I tried moving it to its own workflow file on my fork, seems to work just fine: DeeDeeG@7564e32

Feel free to copy that if wanting it in its own separate GitHub Actions workflow file (separate .yml CI file).

[lukekarrys]

@DeeDeeG The comment I left in the code was too vague, sorry about that. I meant I would like to move the whole thing to its own GitHub action to be used like uses: pkgjs/check-engines.

I use this same action other places and I'd love to find a good org for to be used ecosystem-wide. I talked a bit to some folks at the pkgjs org and I think that might be a good place for it.

[DeeDeeG]

You might have seen this already, but the updated engines: field got removed in one of the force pushes, and some just-merged dependency bumps are failing the "Check Engines" job in CI without that updated engines: value.

NodeJS 14 is still in there, and the 16 is still ^16.13.0 instead of ^16.14.0.

EDIT: Okay, yep, fixed just now via #2929. Disregard this comment.

[lukekarrys]

I was having some trouble getting the tests passing in CI so I decided to separate out all the commits into separate PRs. It did end up showing that the check-engines job will work though! 😄