nodejs / node-api-headers

Repository used to make the N-API headers more accessible

MIT License

32 stars 13 forks source link

Add helper scripts for updating headers and symbols.js #7

Closed KevinEady closed 1 year ago

KevinEady commented 1 year ago

Added two new scripts runnable via npm:

npm run-script update-headers: Fetch latest headers from nodejs/node and removes NAPI_EXPERIMENTAL preprocessor checks of #ifdef and #ifndef, assuming it is not defined.
npm run-script write-symbols: Use clang to process headers to create symbols.js

This PR also adds a GitHub Actions workflow for performing the sync on a daily schedule (also can be manually triggered).

Relates: #2

KevinEady commented 1 year ago

Sample Action Runs

Do not create PR if branch exists

https://github.com/KevinEady/node-api-headers/actions/runs/3809916576/jobs/6481635210 created PR https://github.com/KevinEady/node-api-headers/pull/1
https://github.com/KevinEady/node-api-headers/actions/runs/3809925731/jobs/6481651773 did not create PR since branch existed

Do not create PR if no changes

https://github.com/KevinEady/node-api-headers/actions/runs/3810377453/jobs/6482423061 created PR https://github.com/KevinEady/node-api-headers/pull/5
https://github.com/KevinEady/node-api-headers/actions/runs/3814262603/jobs/6488415128#step:4:34 did not create PR since no changes exist

Run on daily schedule at 00:00 UTC

https://github.com/KevinEady/node-api-headers/actions/runs/3814262603/jobs/6488415128

KevinEady commented 1 year ago

Run from https://github.com/nodejs/node-api-headers/pull/7/commits/b9a57c3721c8be26c76a5e2777e05ed3886a938b: https://github.com/KevinEady/node-api-headers/actions/runs/3830241460/jobs/6517859978 creating PR https://github.com/KevinEady/node-api-headers/pull/6

KevinEady commented 1 year ago

Run from https://github.com/nodejs/node-api-headers/pull/7/commits/219ad9f098f1888b0f9c6dd9189c8baa6770eee4: https://github.com/KevinEady/node-api-headers/actions/runs/3857398501/jobs/6574747611 creating PR https://github.com/KevinEady/node-api-headers/pull/7

mhdawson commented 1 year ago

@KevinEady I think when we discussed in a Node-API meeting you were going to update to remove the Experimental part of the headers. Was that added and I just can't find it?

mhdawson commented 1 year ago

@KevinEady, I found the part that removes the experimental functions from the symbols but I think we also should do that in the header file as well.

KevinEady commented 1 year ago

@KevinEady, I found the part that removes the experimental functions from the symbols but I think we also should do that in the header file as well.

Addressed in https://github.com/nodejs/node-api-headers/compare/41f0767...36a1e92b19642782e459d129657d5dbe761aa1ce

This action run https://github.com/KevinEady/node-api-headers/actions/runs/4174541956/jobs/7228252444 created PR https://github.com/KevinEady/node-api-headers/pull/10/files?diff=split&w=1

@NickNaso @mhdawson this is ready for review again