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: elevate diagnostic report to tier1 #32732

Closed
wants to merge 2 commits into from

Conversation

gireeshpunathil
Copy link
Member

diagnostic WG recommends that: diagnostic report qualifies for all the criteria for being in tier1. Classify it as such.

checklist:

criteria status
The maintainers of the tool must remain responsive when there are problems tool is part of the core, so maintainers are node core collaborators itself
The tool must be actively used by the ecosystem evidence of usage in the field - through core and help repo issues, as well as in person feedback in collab summit 2019 montreal
The tool must be heavily depended on subjective, but report is being established as a unique FFDC capability that helped many issues so far
The tool must have a guide or other documentation in the Node.js GitHub organization or website API guide exists part of the org, and several external documentations
The tool must be working on all supported platforms Achieved, functional on all platforms where Node.js is supported
The tool must only be using APIs exposed by Node.js as opposed to its dependencies; and the tool must be open source Achieved
  • this is the first time a tool is potentially entering the tier1 status. As per the documented process, the most notable one is: A release will not be shipped if the test suite for the tool/API is not green. (this page, second para). So alerting the release team for their awareness and / or review.

  • @richardlau raised a point about retaining node-report in the unclassified list. While diagnostic report is replacement of node-report in principle, in reality both need to co-exist until v10.x goes out of support (04/21). I am fine in either way, but my opinion is to replace node-report in the list - node-report is an npm module, so its support tier status listing in core as unclassified or absence of it may not be too critical to the ecosystem.

Refs: nodejs/diagnostics#369
/cc @nodejs/releasers
/cc @nodejs/diagnostics
/cc @nodejs/tooling

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

diagnostic report qualifies for all the criteria for
being in tier1. Classify it as such.
@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Apr 9, 2020
@@ -123,7 +124,6 @@ The tools are currently assigned to Tiers as follows:

| Tool Type | Tool/API Name | Regular Testing in Node.js CI | Integrated with Node.js | Target Tier |
|-----------|---------------------------|-------------------------------|-------------------------|-------------|
| FFDC | node-report | No | No | 1 |
Copy link
Member

Choose a reason for hiding this comment

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

I would rather either keep the npm node-report module as unclassified or moved to tier 4.

Copy link
Member

Choose a reason for hiding this comment

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

I would move it to tier unclassified.

Copy link
Member Author

Choose a reason for hiding this comment

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

@richardlau @mhdawson - reverted the case of node-report, PTAL!

@richardlau
Copy link
Member

* this is the first time a tool is potentially entering the `tier1` status. As per the documented process, the most notable one is: `A release will not be shipped if the test suite for the tool/API is not green.` (this page, second para). So alerting the release team for their awareness and / or review.

For diagnostics report, since it's in core the tests for it are part of the regular test CI so no concerns there.

I'm not sure the Release WG has been consulted on the broader Tier requirements. The only mechanism we have of running tests for releases is either (a) tests that exist in core and are therefore run as part of regular/nightly CI, or (b) CITGM (which can only test npms). I'm hesitant to place more requirements in the future on @nodejs/releasers.

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

@mmarchini
Copy link
Contributor

@richardlau agreed, for those tools to be tier 1 they need to be tested either on Node.js core or as part of CITGM. We should add this as a pre-requirement for Tier 1.

Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

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

lgtm

jasnell pushed a commit that referenced this pull request Apr 23, 2020
diagnostic report qualifies for all the criteria for
being in tier1. Classify it as such.

PR-URL: #32732
Refs: nodejs/diagnostics#369
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Matheus Marchini <mat@mmarchini.me>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@jasnell
Copy link
Member

jasnell commented Apr 23, 2020

Landed in 6ad65ae

@jasnell jasnell closed this Apr 23, 2020
BethGriggs pushed a commit that referenced this pull request Apr 27, 2020
diagnostic report qualifies for all the criteria for
being in tier1. Classify it as such.

PR-URL: #32732
Refs: nodejs/diagnostics#369
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Matheus Marchini <mat@mmarchini.me>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@BethGriggs BethGriggs mentioned this pull request Apr 27, 2020
BridgeAR pushed a commit that referenced this pull request Apr 28, 2020
diagnostic report qualifies for all the criteria for
being in tier1. Classify it as such.

PR-URL: #32732
Refs: nodejs/diagnostics#369
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Matheus Marchini <mat@mmarchini.me>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@BridgeAR BridgeAR mentioned this pull request Apr 28, 2020
targos pushed a commit that referenced this pull request Apr 30, 2020
diagnostic report qualifies for all the criteria for
being in tier1. Classify it as such.

PR-URL: #32732
Refs: nodejs/diagnostics#369
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Matheus Marchini <mat@mmarchini.me>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit that referenced this pull request May 13, 2020
diagnostic report qualifies for all the criteria for
being in tier1. Classify it as such.

PR-URL: #32732
Refs: nodejs/diagnostics#369
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Matheus Marchini <mat@mmarchini.me>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: James M Snell <jasnell@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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants