Skip to content

doc: document node-api version process - #47972

Merged
nodejs-github-bot merged 2 commits into
nodejs:mainfrom
legendecas:node-api/release
May 19, 2023
Merged

doc: document node-api version process#47972
nodejs-github-bot merged 2 commits into
nodejs:mainfrom
legendecas:node-api/release

Conversation

@legendecas

@legendecaslegendecas commented May 12, 2023

Copy link
Copy Markdown
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

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

nodejs-github-bot commented May 12, 2023•
edited by legendecas
Loading

Copy link
Copy Markdown
Collaborator

Review requested:

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

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

gabrielschulhof commented May 12, 2023

Copy link
Copy Markdown
Contributor

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

VoltrexKeyva
VoltrexKeyva reviewed May 12, 2023
View reviewed changes
Comment threaddoc/contributing/releases-node-api.md Outdated

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

#### Step 4. Update test version guards

@VoltrexKeyvaVoltrexKeyvaMay 12, 2023

Copy link
Copy Markdown
Contributor

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.

@legendecaslegendecasMay 17, 2023

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Thanks, updated!

Comment threaddoc/contributing/releases-node-api.md Outdated
Comment threaddoc/contributing/releases-node-api.md Outdated
gabrielschulhof
gabrielschulhof reviewed May 13, 2023
View reviewed changes

@gabrielschulhofgabrielschulhof left a comment

Copy link
Copy Markdown
Contributor

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.

Comment threaddoc/contributing/releases-node-api.md Outdated
Comment threaddoc/contributing/releases-node-api.md Outdated
Comment threaddoc/contributing/releases-node-api.md Outdated
Comment threaddoc/contributing/releases-node-api.md Outdated
Comment threaddoc/contributing/releases-node-api.md Outdated
Comment threaddoc/contributing/releases-node-api.md Outdated
Comment threaddoc/contributing/releases-node-api.md Outdated
Comment threaddoc/contributing/releases-node-api.md
gabrielschulhof
gabrielschulhof reviewed May 13, 2023
View reviewed changes
Comment threaddoc/contributing/releases-node-api.md
@legendecas

legendecas commented May 17, 2023

Copy link
Copy Markdown
MemberAuthor

@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.

mhdawson
mhdawson approved these changes May 18, 2023
View reviewed changes

@mhdawsonmhdawson left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@legendecaslegendecas added the commit-queue Add this label to land a pull request using GitHub Actions. label May 19, 2023
@nodejs-github-botnodejs-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:mainMay 19, 2023
@nodejs-github-bot

nodejs-github-bot commented May 19, 2023

Copy link
Copy Markdown
Collaborator

Landed in 1918241

@legendecas
legendecas deleted the node-api/release branch May 19, 2023 02:50
targos pushed a commit that referenced this pull request May 30, 2023
@legendecas@targos
doc: document node-api version process
0e4a3b7
PR-URL: #47972Fixes: #47664
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Gabriel Schulhof <gabrielschulhof@gmail.com>
@targostargos mentioned this pull request Jun 4, 2023
Merged
danielleadams pushed a commit that referenced this pull request Jul 6, 2023
@legendecas@danielleadams
doc: document node-api version process
d60c99a
PR-URL: #47972Fixes: #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
@legendecas@MoLow
doc: document node-api version process
c22f739
PR-URL: nodejs#47972Fixes: nodejs#47664
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Gabriel Schulhof <gabrielschulhof@gmail.com>
@danielleadamsdanielleadams mentioned this pull request Jul 10, 2023
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@gabrielschulhofgabrielschulhofgabrielschulhof approved these changes
@RafaelGSSRafaelGSSRafaelGSS approved these changes
+3 more reviewers
@VoltrexKeyvaVoltrexKeyvaVoltrexKeyva left review comments
@mhdawsonmhdawsonmhdawson approved these changes
@aymen94aymen94aymen94 approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

docIssues and PRs related to the documentations.node-apiIssues and PRs related to the Node-API.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Create a Node-API release checklist

7 participants

@legendecas@nodejs-github-bot@gabrielschulhof@mhdawson@aymen94@RafaelGSS@VoltrexKeyva