Skip to content

doc: update stability status for diagnostics_channel to experimental #58261

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

Merged
merged 3 commits into from
May 13, 2025

Conversation

idango10
Copy link
Contributor

Fixes: #58234

@nodejs-github-bot nodejs-github-bot added diagnostics_channel Issues and PRs related to diagnostics channel doc Issues and PRs related to the documentations. labels May 10, 2025
Comment on lines -1106 to -1111
> Stability: 1 - Experimental
While the diagnostics\_channel API is now considered stable, the built-in
channels currently available are not. Each channel must be declared stable
independently.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was initially unsure whether this part should be removed, but after seeing the CI fail due to a duplicate stability status inherited from the parent (https://github.com/nodejs/node/actions/runs/14946879215/job/41993454082?pr=58261), it seems that it needs to be taken out.

@timorthegreat timorthegreat mentioned this pull request May 11, 2025
Copy link
Member

@RaisinTen RaisinTen left a comment

Choose a reason for hiding this comment

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

A channel for HTTP/2 has landed recently. Can you rebase and add experimental to that one also?

@idango10
Copy link
Contributor Author

A channel for HTTP/2 has landed recently. Can you rebase and add experimental to that one also?

Added 😃

Copy link
Member

@RaisinTen RaisinTen left a comment

Choose a reason for hiding this comment

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

LGTM, thanks

@RaisinTen RaisinTen added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue Add this label to land a pull request using GitHub Actions. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. labels May 12, 2025
@nodejs-github-bot 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 May 12, 2025
@nodejs-github-bot
Copy link
Collaborator

Commit Queue failed
- Loading data for nodejs/node/pull/58261
✔  Done loading data for nodejs/node/pull/58261
----------------------------------- PR info ------------------------------------
Title      doc: update stability status for diagnostics_channel to experimental (#58261)
   ⚠  Could not retrieve the email or name of the PR author's from user's GitHub profile!
Branch     idango10:idango/fix-58234 -> nodejs:main
Labels     doc, author ready, diagnostics_channel, commit-queue-squash
Commits    4
 - doc: update stability status for diagnostics_channel to experimental
 - fix: remove duplicate stability status from the parent
 - Merge branch 'main' into idango/fix-58234
 - doc: add experimental status to HTTP/2
Committers 2
 - idango10 <[email protected]>
 - idango10 <[email protected]>
PR-URL: https://github.com/nodejs/node/pull/58261
Fixes: https://github.com/nodejs/node/issues/58234
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Edy Silva <[email protected]>
Reviewed-By: Yagiz Nizipli <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/58261
Fixes: https://github.com/nodejs/node/issues/58234
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Edy Silva <[email protected]>
Reviewed-By: Yagiz Nizipli <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
--------------------------------------------------------------------------------
   ℹ  This PR was created on Sat, 10 May 2025 15:53:05 GMT
   ✔  Approvals: 4
   ✔  - James M Snell (@jasnell) (TSC): https://github.com/nodejs/node/pull/58261#pullrequestreview-2830922678
   ✔  - Edy Silva (@geeksilva97): https://github.com/nodejs/node/pull/58261#pullrequestreview-2830929787
   ✔  - Yagiz Nizipli (@anonrig) (TSC): https://github.com/nodejs/node/pull/58261#pullrequestreview-2831018048
   ✔  - Darshan Sen (@RaisinTen) (TSC): https://github.com/nodejs/node/pull/58261#pullrequestreview-2833122690
   ✔  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
✔  origin/main is now up-to-date
- Downloading patch for 58261
From https://github.com/nodejs/node
 * branch                  refs/pull/58261/merge -> FETCH_HEAD
✔  Fetched commits as 2281a04e5e38..47a213a8ca55
--------------------------------------------------------------------------------
Auto-merging doc/api/diagnostics_channel.md
[main 5647bcd117] doc: update stability status for diagnostics_channel to experimental
 Author: idango10 <[email protected]>
 Date: Sat May 10 18:51:38 2025 +0300
 1 file changed, 14 insertions(+)
Auto-merging doc/api/diagnostics_channel.md
error: commit 5d760725011411d86dc48b2b62ecaf8c7b88e65e is a merge but no -m option was given.
fatal: cherry-pick failed
[main b6be9672b9] fix: remove duplicate stability status from the parent
 Author: idango10 <[email protected]>
 Date: Sat May 10 21:11:54 2025 +0300
 1 file changed, 6 deletions(-)
   ✘  Failed to apply patches
https://github.com/nodejs/node/actions/runs/14976819325

@idango10
Copy link
Contributor Author

Commit Queue failed

@RaisinTen looks like the commit-queue failed because I didn't have a name and an email on my profile 😅
Added them both so it should hopefully pass now.

@geeksilva97 geeksilva97 added commit-queue Add this label to land a pull request using GitHub Actions. and removed commit-queue-failed An error occurred while landing this pull request using GitHub Actions. labels May 12, 2025
@nodejs-github-bot 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 May 12, 2025
@nodejs-github-bot
Copy link
Collaborator

Commit Queue failed
- Loading data for nodejs/node/pull/58261
✔  Done loading data for nodejs/node/pull/58261
----------------------------------- PR info ------------------------------------
Title      doc: update stability status for diagnostics_channel to experimental (#58261)
Author     Idan Goshen <[email protected]> (@idango10, first-time contributor)
Branch     idango10:idango/fix-58234 -> nodejs:main
Labels     doc, author ready, diagnostics_channel, commit-queue-squash
Commits    4
 - doc: update stability status for diagnostics_channel to experimental
 - fix: remove duplicate stability status from the parent
 - Merge branch 'main' into idango/fix-58234
 - doc: add experimental status to HTTP/2
Committers 2
 - idango10 <[email protected]>
 - idango10 <[email protected]>
PR-URL: https://github.com/nodejs/node/pull/58261
Fixes: https://github.com/nodejs/node/issues/58234
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Edy Silva <[email protected]>
Reviewed-By: Yagiz Nizipli <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/58261
Fixes: https://github.com/nodejs/node/issues/58234
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Edy Silva <[email protected]>
Reviewed-By: Yagiz Nizipli <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
--------------------------------------------------------------------------------
   ℹ  This PR was created on Sat, 10 May 2025 15:53:05 GMT
   ✔  Approvals: 4
   ✔  - James M Snell (@jasnell) (TSC): https://github.com/nodejs/node/pull/58261#pullrequestreview-2830922678
   ✔  - Edy Silva (@geeksilva97): https://github.com/nodejs/node/pull/58261#pullrequestreview-2830929787
   ✔  - Yagiz Nizipli (@anonrig) (TSC): https://github.com/nodejs/node/pull/58261#pullrequestreview-2831018048
   ✔  - Darshan Sen (@RaisinTen) (TSC): https://github.com/nodejs/node/pull/58261#pullrequestreview-2833122690
   ✔  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
✔  origin/main is now up-to-date
- Downloading patch for 58261
From https://github.com/nodejs/node
 * branch                  refs/pull/58261/merge -> FETCH_HEAD
✔  Fetched commits as 292263e3780b..47a213a8ca55
--------------------------------------------------------------------------------
Auto-merging doc/api/diagnostics_channel.md
[main 694cb28388] doc: update stability status for diagnostics_channel to experimental
 Author: idango10 <[email protected]>
 Date: Sat May 10 18:51:38 2025 +0300
 1 file changed, 14 insertions(+)
Auto-merging doc/api/diagnostics_channel.md
error: commit 5d760725011411d86dc48b2b62ecaf8c7b88e65e is a merge but no -m option was given.
fatal: cherry-pick failed
[main 2ab8195a5c] fix: remove duplicate stability status from the parent
 Author: idango10 <[email protected]>
 Date: Sat May 10 21:11:54 2025 +0300
 1 file changed, 6 deletions(-)
   ✘  Failed to apply patches
https://github.com/nodejs/node/actions/runs/14979428769

@idango10 idango10 force-pushed the idango/fix-58234 branch from 47a213a to 18e3e05 Compare May 12, 2025 18:44
@idango10
Copy link
Contributor Author

idango10 commented May 12, 2025

@geeksilva97 hey, it seems to fail now because I merged main instead of rebasing it.
I rebased it and pretty sure now it should work properly. Sorry for the confusion.

@geeksilva97
Copy link
Contributor

@geeksilva97 hey, it seems to fail now because I merged main instead of rebasing it. I rebased it and pretty sure now it should work properly. Sorry for the confusion.

No prob. Will try again

@RaisinTen RaisinTen removed the commit-queue-failed An error occurred while landing this pull request using GitHub Actions. label May 13, 2025
@RaisinTen RaisinTen added the commit-queue Add this label to land a pull request using GitHub Actions. label May 13, 2025
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label May 13, 2025
@nodejs-github-bot nodejs-github-bot merged commit a4e833a into nodejs:main May 13, 2025
18 checks passed
@nodejs-github-bot
Copy link
Collaborator

Landed in a4e833a

@idango10 idango10 deleted the idango/fix-58234 branch May 13, 2025 07:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. diagnostics_channel Issues and PRs related to diagnostics channel doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Should document stability of diagnostics_channel publishers.
6 participants