doc: mark --cpu-prof and --heap-prof as stable by joyeecheung · Pull Request #53343 · nodejs/node

joyeecheung · 2024-06-05T10:21:32Z

As far as I remember the reason for keeping them experimental was to leave some room to allow (potentially breaking) customization of directories and profile name patterns. But at this point it seems the --diagnostic-dir option that controls the default directory works well enough for the first case, and profile name patterns are part of a bigger issue of name patterns for many other outputs (reports, traces, etc.) and I expect any breaking changes will need to be semver-major together with other stable features that would share the same customization. So there is not really any point to keep them experimental (also, I believe they have been used enough in the wild that it may be unwise to break them without going semver-major at this point). So this PR just marks them as stable since that's already the reality.

joyeecheung · 2024-06-05T10:28:27Z

I believe the process requires pinging the TSC when changing the stability index, so cc @nodejs/tsc

mcollina

lgtm

mhdawson

LGTM

nodejs-github-bot · 2024-06-07T11:37:00Z

Commit Queue failed

- Loading data for nodejs/node/pull/53343 ✔ Done loading data for nodejs/node/pull/53343 ----------------------------------- PR info ------------------------------------ Title doc: mark --cpu-prof and --heap-prof as stable (#53343) Author Joyee Cheung (@joyeecheung) Branch joyeecheung:prof-stable -> nodejs:main Labels doc, cli, author ready Commits 2 - doc: mark --cpu-prof and related flags stable - doc: mark --heap-prof and related flags stable Committers 1 - Joyee Cheung PR-URL: https://github.com/nodejs/node/pull/53343 Reviewed-By: Matteo Collina Reviewed-By: Richard Lau Reviewed-By: Paolo Insogna Reviewed-By: Ruy Adorno Reviewed-By: Marco Ippolito Reviewed-By: Chengzhong Wu Reviewed-By: Luigi Pinca Reviewed-By: Michael Dawson Reviewed-By: Trivikram Kamat ------------------------------ Generated metadata ------------------------------ PR-URL: https://github.com/nodejs/node/pull/53343 Reviewed-By: Matteo Collina Reviewed-By: Richard Lau Reviewed-By: Paolo Insogna Reviewed-By: Ruy Adorno Reviewed-By: Marco Ippolito Reviewed-By: Chengzhong Wu Reviewed-By: Luigi Pinca Reviewed-By: Michael Dawson Reviewed-By: Trivikram Kamat -------------------------------------------------------------------------------- ℹ This PR was created on Wed, 05 Jun 2024 10:21:32 GMT ✔ Approvals: 9 ✔ - Matteo Collina (@mcollina) (TSC): https://github.com/nodejs/node/pull/53343#pullrequestreview-2098775174 ✔ - Richard Lau (@richardlau) (TSC): https://github.com/nodejs/node/pull/53343#pullrequestreview-2098794896 ✔ - Paolo Insogna (@ShogunPanda) (TSC): https://github.com/nodejs/node/pull/53343#pullrequestreview-2098801130 ✔ - Ruy Adorno (@ruyadorno) (TSC): https://github.com/nodejs/node/pull/53343#pullrequestreview-2099519437 ✔ - Marco Ippolito (@marco-ippolito) (TSC): https://github.com/nodejs/node/pull/53343#pullrequestreview-2099556656 ✔ - Chengzhong Wu (@legendecas) (TSC): https://github.com/nodejs/node/pull/53343#pullrequestreview-2101341580 ✔ - Luigi Pinca (@lpinca): https://github.com/nodejs/node/pull/53343#pullrequestreview-2103112398 ✔ - Michael Dawson (@mhdawson) (TSC): https://github.com/nodejs/node/pull/53343#pullrequestreview-2103234911 ✔ - Trivikram Kamat (@trivikr): https://github.com/nodejs/node/pull/53343#pullrequestreview-2103692231 ✔ Last GitHub CI successful ℹ Green GitHub CI is sufficient -------------------------------------------------------------------------------- ✔ No git cherry-pick in progress ✔ No git am in progress ✔ No git rebase in progress -------------------------------------------------------------------------------- - Bringing origin/main up to date... From https://github.com/nodejs/node * branch main -> FETCH_HEAD 479b8e5232..a2233c39c8 main -> origin/main ✔ origin/main is now up-to-date main is out of sync with origin/main. Mismatched commits: - ab971dc739 src: use v8::(Des|S)erializeInternalFieldsCallback - a2233c39c8 src: use v8::(Des|S)erializeInternalFieldsCallback -------------------------------------------------------------------------------- HEAD is now at a2233c39c8 src: use v8::(Des|S)erializeInternalFieldsCallback ✔ Reset to origin/main - Downloading patch for 53343 From https://github.com/nodejs/node * branch refs/pull/53343/merge -> FETCH_HEAD ✔ Fetched commits as a2233c39c830..4dda1e792a8a -------------------------------------------------------------------------------- Auto-merging doc/api/cli.md [main d088d84b6d] doc: mark --cpu-prof and related flags stable Author: Joyee Cheung Date: Wed Jun 5 12:16:00 2024 +0200 1 file changed, 24 insertions(+), 4 deletions(-) Auto-merging doc/api/cli.md [main 80e66b769c] doc: mark --heap-prof and related flags stable Author: Joyee Cheung Date: Wed Jun 5 12:17:10 2024 +0200 1 file changed, 24 insertions(+), 4 deletions(-) ✔ Patches applied There are 2 commits in the PR. Attempting autorebase. Rebasing (2/4)

Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
doc: mark --cpu-prof and related flags stable

PR-URL: #53343
Reviewed-By: Matteo Collina matteo.collina@gmail.com
Reviewed-By: Richard Lau rlau@redhat.com
Reviewed-By: Paolo Insogna paolo@cowtech.it
Reviewed-By: Ruy Adorno ruy@vlt.sh
Reviewed-By: Marco Ippolito marcoippolito54@gmail.com
Reviewed-By: Chengzhong Wu legendecas@gmail.com
Reviewed-By: Luigi Pinca luigipinca@gmail.com
Reviewed-By: Michael Dawson midawson@redhat.com
Reviewed-By: Trivikram Kamat trivikr.dev@gmail.com

[detached HEAD cca8f48939] doc: mark --cpu-prof and related flags stable
Author: Joyee Cheung joyeec9h3@gmail.com
Date: Wed Jun 5 12:16:00 2024 +0200
1 file changed, 24 insertions(+), 4 deletions(-)
Rebasing (3/4)
Rebasing (4/4)

Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
doc: mark --heap-prof and related flags stable

PR-URL: #53343
Reviewed-By: Matteo Collina matteo.collina@gmail.com
Reviewed-By: Richard Lau rlau@redhat.com
Reviewed-By: Paolo Insogna paolo@cowtech.it
Reviewed-By: Ruy Adorno ruy@vlt.sh
Reviewed-By: Marco Ippolito marcoippolito54@gmail.com
Reviewed-By: Chengzhong Wu legendecas@gmail.com
Reviewed-By: Luigi Pinca luigipinca@gmail.com
Reviewed-By: Michael Dawson midawson@redhat.com
Reviewed-By: Trivikram Kamat trivikr.dev@gmail.com

[detached HEAD 8666c6ff97] doc: mark --heap-prof and related flags stable
Author: Joyee Cheung joyeec9h3@gmail.com
Date: Wed Jun 5 12:17:10 2024 +0200
1 file changed, 24 insertions(+), 4 deletions(-)

Successfully rebased and updated refs/heads/main.

ℹ Add commit-queue-squash label to land the PR as one commit, or commit-queue-rebase to land as separate commits.

https://github.com/nodejs/node/actions/runs/9416349123

PR-URL: #53343 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Paolo Insogna <paolo@cowtech.it> Reviewed-By: Ruy Adorno <ruy@vlt.sh> Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>

nodejs-github-bot · 2024-06-07T13:48:30Z

Landed in 1945072...673511f

PR-URL: #53343 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Paolo Insogna <paolo@cowtech.it> Reviewed-By: Ruy Adorno <ruy@vlt.sh> Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>

PR-URL: nodejs#53343 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Paolo Insogna <paolo@cowtech.it> Reviewed-By: Ruy Adorno <ruy@vlt.sh> Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>

Notable changes: deps,lib,src: * (SEMVER-MINOR) add experimental web storage (Colin Ihrig) #52435 doc: * move `node --run` stability to rc (Yagiz Nizipli) #53433 * mark WebSocket as stable (Matthew Aitken) #53352 * mark --heap-prof and related flags stable (Joyee Cheung) #53343 * mark --cpu-prof and related flags stable (Joyee Cheung) #53343 * doc-only deprecate OpenSSL engine-based APIs (Richard Lau) #53329 inspector: * fix disable async hooks on Debugger.setAsyncCallStackDepth (Joyee Cheung) #53473 lib: * (SEMVER-MINOR) add diagnostics_channel events to module loading (RafaelGSS) #44340 util: * (SEMVER-MINOR) support `--no-` for argument with boolean type for parseArgs (Zhenwei Jin) #53107 PR-URL: #53583

PR-URL: #53343 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Paolo Insogna <paolo@cowtech.it> Reviewed-By: Ruy Adorno <ruy@vlt.sh> Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>

nodejs-github-bot added cli Issues and PRs related to the Node.js command line interface. doc Issues and PRs related to the documentations. labels Jun 5, 2024

joyeecheung force-pushed the prof-stable branch from 1bcba64 to 1998e4d Compare June 5, 2024 10:23

joyeecheung added 2 commits June 5, 2024 12:27

doc: mark --cpu-prof and related flags stable

51acf22

doc: mark --heap-prof and related flags stable

4dda1e7

joyeecheung force-pushed the prof-stable branch from 1998e4d to 4dda1e7 Compare June 5, 2024 10:28

mcollina approved these changes Jun 5, 2024

View reviewed changes

richardlau approved these changes Jun 5, 2024

View reviewed changes

ShogunPanda approved these changes Jun 5, 2024

View reviewed changes

ruyadorno approved these changes Jun 5, 2024

View reviewed changes

marco-ippolito approved these changes Jun 5, 2024

View reviewed changes

legendecas approved these changes Jun 6, 2024

View reviewed changes

joyeecheung added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jun 6, 2024

lpinca approved these changes Jun 6, 2024

View reviewed changes

mhdawson approved these changes Jun 6, 2024

View reviewed changes

trivikr approved these changes Jun 7, 2024

View reviewed changes

joyeecheung added the commit-queue Add this label to land a pull request using GitHub Actions. label Jun 7, 2024

nodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Jun 7, 2024

gireeshpunathil approved these changes Jun 7, 2024

View reviewed changes

RafaelGSS approved these changes Jun 7, 2024

View reviewed changes

nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Jun 7, 2024

nodejs-github-bot closed this Jun 7, 2024

targos mentioned this pull request Jun 25, 2024

v22.4.0 release proposal #53583

Merged

Karliz24 mentioned this pull request Jul 9, 2024

## 2024-07-02, Version 22.4.0 (Current), @targos Karliz24/Marley-#16

Open

marco-ippolito mentioned this pull request Jul 19, 2024

v20.16.0 proposal #53945

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

doc: mark --cpu-prof and --heap-prof as stable#53343

doc: mark --cpu-prof and --heap-prof as stable#53343
joyeecheung wants to merge 2 commits intonodejs:mainfrom
joyeecheung:prof-stable

joyeecheung commented Jun 5, 2024

Uh oh!

joyeecheung commented Jun 5, 2024

Uh oh!

mcollina left a comment

Uh oh!

mhdawson left a comment

Uh oh!

nodejs-github-bot commented Jun 7, 2024

Successfully rebased and updated refs/heads/main.

Uh oh!

nodejs-github-bot commented Jun 7, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

13 participants

Uh oh!

Conversation

joyeecheung commented Jun 5, 2024

Uh oh!

joyeecheung commented Jun 5, 2024

Uh oh!

mcollina left a comment

Choose a reason for hiding this comment

Uh oh!

mhdawson left a comment

Choose a reason for hiding this comment

Uh oh!

nodejs-github-bot commented Jun 7, 2024

Successfully rebased and updated refs/heads/main.

Uh oh!

nodejs-github-bot commented Jun 7, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

13 participants