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

doc: document node-api version process #47972

Merged
merged 2 commits into from
May 19, 2023

Conversation

legendecas
Copy link
Member

With the change in #45715 landed, there are several code sites that need to be updated with the release Node-API version when a new Node-API version is being released.

This PR adds a document to the guides of a checklist necessary for creating a Node-API release PR.

Fixes: #47664

@legendecas legendecas added the node-api Issues and PRs related to the Node-API. label May 12, 2023
@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented May 12, 2023

Review requested:

  • @nodejs/tsc
  • @nodejs/node-api

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label May 12, 2023
@gabrielschulhof
Copy link
Contributor

Please also document the process mentioned in #47975 (comment)!


and substitute this guard version with the release version `x`.

#### Step 4. Update test version guards
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#### Step 4. Update test version guards
#### Step 3. Update test version guards

The next step is step 4.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, updated!

doc/contributing/releases-node-api.md Outdated Show resolved Hide resolved
doc/contributing/releases-node-api.md Outdated Show resolved Hide resolved
Copy link
Contributor

@gabrielschulhof gabrielschulhof left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doc looks great! Just a few comments.

doc/contributing/releases-node-api.md Outdated Show resolved Hide resolved
doc/contributing/releases-node-api.md Outdated Show resolved Hide resolved
doc/contributing/releases-node-api.md Outdated Show resolved Hide resolved
doc/contributing/releases-node-api.md Outdated Show resolved Hide resolved
doc/contributing/releases-node-api.md Outdated Show resolved Hide resolved
doc/contributing/releases-node-api.md Outdated Show resolved Hide resolved
doc/contributing/releases-node-api.md Outdated Show resolved Hide resolved
doc/contributing/releases-node-api.md Show resolved Hide resolved
@legendecas
Copy link
Member Author

@gabrielschulhof thanks for the suggestions! I've added a section to update the change history and backport the release to LTS lines. Please take a look again.

Copy link
Member

@mhdawson mhdawson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@legendecas legendecas added the commit-queue Add this label to land a pull request using GitHub Actions. label May 19, 2023
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label May 19, 2023
@nodejs-github-bot nodejs-github-bot merged commit 1918241 into nodejs:main May 19, 2023
@nodejs-github-bot
Copy link
Collaborator

Landed in 1918241

@legendecas legendecas deleted the node-api/release branch May 19, 2023 02:50
fasenderos pushed a commit to fasenderos/node that referenced this pull request 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 pull request 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>
@targos targos mentioned this pull request Jun 4, 2023
danielleadams pushed a commit that referenced this pull request 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 pull request 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
doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create a Node-API release checklist
7 participants