Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a Node-API release checklist #47664

Closed
gabrielschulhof opened this issue Apr 22, 2023 · 1 comment · Fixed by #47972
Closed

Create a Node-API release checklist #47664

gabrielschulhof opened this issue Apr 22, 2023 · 1 comment · Fixed by #47972
Labels
feature request Issues that request new features to be added to Node.js. node-api Issues and PRs related to the Node-API.

Comments

@gabrielschulhof
Copy link
Contributor

What is the problem this feature will solve?

We need to make sure when we release a new version of Node-API we do not overlook any of the steps.

What is the feature you are proposing to solve the problem?

Let's add a document to the guides containing a list of steps necessary for creating a Node-API release PR.

What alternatives have you considered?

Looking at existing release commits to remember the steps. However, a new step will be added at https://github.com/nodejs/node/pull/45715/files#diff-2057dbe503dbb37a65a74cf86e056d50c27ba828070577e0f7f07e734365c9bcR658 which previous releases will not reflect.

@gabrielschulhof gabrielschulhof added feature request Issues that request new features to be added to Node.js. node-api Issues and PRs related to the Node-API. labels Apr 22, 2023
@gabrielschulhof
Copy link
Contributor Author

gabrielschulhof commented May 5, 2023

With #45715 landed, the document must also mention that, as part of the release process, not only will new APIs in the headers have to be moved from NAPI_EXPERIMENTAL sections to NAPI_VERSION >= n sections, but, in the implementation files (node_api.cc and js_native_api_v8.cc), checks of the form if (env->module_api_version != NAPI_EXPERIMENTAL) have to be replaced with checks of the form if (env->module_api_version <= n).

nodejs-github-bot pushed a commit that referenced this issue May 19, 2023
PR-URL: #47972
Fixes: #47664
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Gabriel Schulhof <gabrielschulhof@gmail.com>
fasenderos pushed a commit to fasenderos/node that referenced this issue May 22, 2023
PR-URL: nodejs#47972
Fixes: nodejs#47664
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Gabriel Schulhof <gabrielschulhof@gmail.com>
targos pushed a commit that referenced this issue May 30, 2023
PR-URL: #47972
Fixes: #47664
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Gabriel Schulhof <gabrielschulhof@gmail.com>
danielleadams pushed a commit that referenced this issue Jul 6, 2023
PR-URL: #47972
Fixes: #47664
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Gabriel Schulhof <gabrielschulhof@gmail.com>
MoLow pushed a commit to MoLow/node that referenced this issue Jul 6, 2023
PR-URL: nodejs#47972
Fixes: nodejs#47664
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Gabriel Schulhof <gabrielschulhof@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request Issues that request new features to be added to Node.js. node-api Issues and PRs related to the Node-API.
Projects
Status: Pending Triage
Development

Successfully merging a pull request may close this issue.

1 participant