search

nodejs / node-api-headers

Repository used to make the N-API headers more accessible
MIT License
32 stars 13 forks source link

Initial scaffolding for the project. #1

Closed NickNaso closed 3 years ago

NickNaso commented 3 years ago

This PR has the purpose to provide a first implementation for the project. The header files are placed in a folder called include. I just copied the files:

My idea about is to automate the process of copying the file from the main Node.js repo to this repo. Essentially we could check if the header files on the Node.js repo has been changed and in that case copy them to this repo. What do you think about that? The index.js files expose the include path for the header files and the list of all symbols exported by Node-API.

mhdawson commented 3 years ago

In terms of:

My idea about is to automate the process of copying the file from the main Node.js repo to this repo. Essentially we could check if the header files on the Node.js repo has been changed and in that case copy them to this repo. What do you think about that?

I think we should only update when there is a new version of the NODE-API. Having script to automate that sounds good, but I think we only want new versions when there is a new version of NODE-API, for example adding version 8. This is related to my comment about stripping out the Experimental sections as those will potentially change and I think that adds more complications than we want to try to cope with in providing the headers.

jschlight commented 3 years ago

When we've settled on how we want this to work, I'm happy to take a shot at the GitHub Actions to implement it. They can be triggered on number of different events such as a merge to main.

NickNaso commented 3 years ago

In terms of:

My idea about is to automate the process of copying the file from the main Node.js repo to this repo. Essentially we could check if the header files on the Node.js repo has been changed and in that case copy them to this repo. What do you think about that?

I think we should only update when there is a new version of the NODE-API. Having script to automate that sounds good, but I think we only want new versions when there is a new version of NODE-API, for example adding version 8. This is related to my comment about stripping out the Experimental sections as those will potentially change and I think that adds more complications than we want to try to cope with in providing the headers.

@mhdawson I agree with you we need to identify the changes on the main Node.js repo and check if those changes have produced a new version for the Node-API, in that case we should copy the files and create a new release for the node-api-headers.

mhdawson commented 3 years ago

@NickNaso are there still changes to be made based on the discussion in the issue?

NickNaso commented 3 years ago

@NickNaso are there still changes to be made based on the discussion in the issue?

Hi @mhdawson, I need to update the PR. I try to finish the work in the next days. Sorry for the delay.

mhdawson commented 3 years ago

@KevinEady this look good to you?