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: add report version section #56130

Merged
merged 1 commit into from
Dec 6, 2024

Conversation

legendecas
Copy link
Member

@legendecas legendecas commented Dec 4, 2024

It's always a pain to reference a paragraph in a large section where the paragraph is outstanding and important.

Add a section dedicated for the report version so that it can be easily referenced with URL.

Also, added a version history section to trace back the changes.

Refs: #56068

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. report Issues and PRs related to process.report. labels Dec 4, 2024
@legendecas
Copy link
Member Author

Updated with version histroy section to trace back changes.

@gireeshpunathil would you mind taking a look again? Thank you

@legendecas
Copy link
Member Author

@nodejs/diagnostics would you mind taking a look at this? Thank you!

@gireeshpunathil
Copy link
Member

LGTM again!

@RafaelGSS RafaelGSS added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Dec 6, 2024
@legendecas legendecas added the commit-queue Add this label to land a pull request using GitHub Actions. label Dec 6, 2024
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Dec 6, 2024
@nodejs-github-bot nodejs-github-bot merged commit eb5aa5f into nodejs:main Dec 6, 2024
21 checks passed
@nodejs-github-bot
Copy link
Collaborator

Landed in eb5aa5f

@legendecas legendecas deleted the doc/report-version branch December 6, 2024 13:31
targos pushed a commit that referenced this pull request Dec 6, 2024
PR-URL: #56130
Refs: #56068
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
@aduh95 aduh95 added the backport-requested-v22.x PRs awaiting manual backport to the v22.x-staging branch. label Dec 6, 2024
aduh95 pushed a commit to RafaelGSS/node that referenced this pull request Dec 7, 2024
PR-URL: nodejs#56130
Refs: nodejs#56068
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
@aduh95 aduh95 added backport-open-v22.x Indicate that the PR has an open backport and removed backport-requested-v22.x PRs awaiting manual backport to the v22.x-staging branch. labels Dec 7, 2024
aduh95 pushed a commit to RafaelGSS/node that referenced this pull request Dec 10, 2024
PR-URL: nodejs#56130
Backport-PR-URL: nodejs#56055
Refs: nodejs#56068
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
PR-URL: nodejs#55697
ruyadorno pushed a commit that referenced this pull request Jan 5, 2025
PR-URL: #56130
Backport-PR-URL: #56055
Refs: #56068
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
PR-URL: #55697
ruyadorno added a commit that referenced this pull request Jan 5, 2025
Notable changes:

assert:
  * (SEMVER-MINOR) add partialDeepStrictEqual (Giovanni Bucci) #54630
cli:
  * (SEMVER-MINOR) implement --trace-env and --trace-env-[js|native]-stack (Joyee Cheung) #55604
crypto:
  * graduate WebCryptoAPI Ed25519 and X25519 algorithms as stable (Filip Skokan) #56142
dgram:
  * (SEMVER-MINOR) support blocklist in udp (theanarkh) #56087
doc:
  * stabilize util.styleText (Rafael Gonzaga) #56265
  * move typescript support to active development (Marco Ippolito) #55536
  * add LJHarb to collaborators (Jordan Harband) #56132
  * (SEMVER-MINOR) add report version and history section (Chengzhong Wu) #56130
  * (SEMVER-MINOR) sort --report-exclude alphabetically (Rafael Gonzaga) #55788
doc,lib,src,test:
  * (SEMVER-MINOR) unflag sqlite module (Colin Ihrig) #55890
module:
  * (SEMVER-MINOR) only emit require(esm) warning under --trace-require-module (Joyee Cheung) #56194
  * (SEMVER-MINOR) add module.stripTypeScriptTypes (Marco Ippolito) #55282
  * (SEMVER-MINOR) simplify `findPackageJSON` implementation (Antoine du Hamel) #55412
  * (SEMVER-MINOR) add `findPackageJSON` util (Jacob Smith) #55412
net:
  * (SEMVER-MINOR) support blocklist in net.connect (theanarkh) #56075
  * (SEMVER-MINOR) add SocketAddress.parse (James M Snell) #56076
  * (SEMVER-MINOR) add net.BlockList.isBlockList(value) (James M Snell) #56078
  * (SEMVER-MINOR) support blocklist for net.Server (theanarkh) #56079
process:
  * (SEMVER-MINOR) deprecate `features.{ipv6,uv}` and `features.tls_*` (René) #55545
report:
  * (SEMVER-MINOR) fix typos in report keys and bump the version (Yuan-Ming Hsu) #56068
sqlite:
  * (SEMVER-MINOR) aggregate constants in a single property (Edigleysson Silva (Edy)) #56213
  * (SEMVER-MINOR) add `StatementSync.prototype.iterate` method (tpoisseau) #54213
src:
  * (SEMVER-MINOR) add cli option to preserve env vars on dr (Rafael Gonzaga) #55697
src,lib:
  * (SEMVER-MINOR) stabilize permission model (Rafael Gonzaga) #56201
util:
  * (SEMVER-MINOR) add sourcemap support to getCallSites (Marco Ippolito) #55589

PR-URL: #56329
ruyadorno added a commit that referenced this pull request Jan 6, 2025
Notable changes:

assert:
  * (SEMVER-MINOR) add partialDeepStrictEqual (Giovanni Bucci) #54630
cli:
  * (SEMVER-MINOR) implement --trace-env and --trace-env-[js|native]-stack (Joyee Cheung) #55604
crypto:
  * graduate WebCryptoAPI Ed25519 and X25519 algorithms as stable (Filip Skokan) #56142
dgram:
  * (SEMVER-MINOR) support blocklist in udp (theanarkh) #56087
doc:
  * stabilize util.styleText (Rafael Gonzaga) #56265
  * move typescript support to active development (Marco Ippolito) #55536
  * add LJHarb to collaborators (Jordan Harband) #56132
  * (SEMVER-MINOR) add report version and history section (Chengzhong Wu) #56130
  * (SEMVER-MINOR) sort --report-exclude alphabetically (Rafael Gonzaga) #55788
doc,lib,src,test:
  * (SEMVER-MINOR) unflag sqlite module (Colin Ihrig) #55890
module:
  * (SEMVER-MINOR) only emit require(esm) warning under --trace-require-module (Joyee Cheung) #56194
  * (SEMVER-MINOR) add module.stripTypeScriptTypes (Marco Ippolito) #55282
net:
  * (SEMVER-MINOR) support blocklist in net.connect (theanarkh) #56075
  * (SEMVER-MINOR) add SocketAddress.parse (James M Snell) #56076
  * (SEMVER-MINOR) add net.BlockList.isBlockList(value) (James M Snell) #56078
  * (SEMVER-MINOR) support blocklist for net.Server (theanarkh) #56079
process:
  * (SEMVER-MINOR) deprecate `features.{ipv6,uv}` and `features.tls_*` (René) #55545
report:
  * (SEMVER-MINOR) fix typos in report keys and bump the version (Yuan-Ming Hsu) #56068
sqlite:
  * (SEMVER-MINOR) aggregate constants in a single property (Edigleysson Silva (Edy)) #56213
  * (SEMVER-MINOR) add `StatementSync.prototype.iterate` method (tpoisseau) #54213
src:
  * (SEMVER-MINOR) add cli option to preserve env vars on dr (Rafael Gonzaga) #55697
src,lib:
  * (SEMVER-MINOR) stabilize permission model (Rafael Gonzaga) #56201
util:
  * (SEMVER-MINOR) add sourcemap support to getCallSites (Marco Ippolito) #55589

PR-URL: #56329
ruyadorno added a commit that referenced this pull request Jan 6, 2025
Notable changes:

assert:
  * (SEMVER-MINOR) add partialDeepStrictEqual (Giovanni Bucci) #54630
cli:
  * (SEMVER-MINOR) implement --trace-env and --trace-env-[js|native]-stack (Joyee Cheung) #55604
crypto:
  * graduate WebCryptoAPI Ed25519 and X25519 algorithms as stable (Filip Skokan) #56142
dgram:
  * (SEMVER-MINOR) support blocklist in udp (theanarkh) #56087
doc:
  * stabilize util.styleText (Rafael Gonzaga) #56265
  * move typescript support to active development (Marco Ippolito) #55536
  * add LJHarb to collaborators (Jordan Harband) #56132
  * (SEMVER-MINOR) add report version and history section (Chengzhong Wu) #56130
  * (SEMVER-MINOR) sort --report-exclude alphabetically (Rafael Gonzaga) #55788
doc,lib,src,test:
  * (SEMVER-MINOR) unflag sqlite module (Colin Ihrig) #55890
module:
  * (SEMVER-MINOR) only emit require(esm) warning under --trace-require-module (Joyee Cheung) #56194
  * (SEMVER-MINOR) add module.stripTypeScriptTypes (Marco Ippolito) #55282
net:
  * (SEMVER-MINOR) support blocklist in net.connect (theanarkh) #56075
  * (SEMVER-MINOR) add SocketAddress.parse (James M Snell) #56076
  * (SEMVER-MINOR) add net.BlockList.isBlockList(value) (James M Snell) #56078
  * (SEMVER-MINOR) support blocklist for net.Server (theanarkh) #56079
process:
  * (SEMVER-MINOR) deprecate `features.{ipv6,uv}` and `features.tls_*` (René) #55545
report:
  * (SEMVER-MINOR) fix typos in report keys and bump the version (Yuan-Ming Hsu) #56068
sqlite:
  * (SEMVER-MINOR) aggregate constants in a single property (Edigleysson Silva (Edy)) #56213
  * (SEMVER-MINOR) add `StatementSync.prototype.iterate` method (tpoisseau) #54213
src:
  * (SEMVER-MINOR) add cli option to preserve env vars on dr (Rafael Gonzaga) #55697
src,lib:
  * (SEMVER-MINOR) stabilize permission model (Rafael Gonzaga) #56201
util:
  * (SEMVER-MINOR) add sourcemap support to getCallSites (Marco Ippolito) #55589

PR-URL: #56329
ruyadorno added a commit that referenced this pull request Jan 7, 2025
Notable changes:

assert:
  * (SEMVER-MINOR) add partialDeepStrictEqual (Giovanni Bucci) #54630
cli:
  * (SEMVER-MINOR) implement --trace-env and --trace-env-[js|native]-stack (Joyee Cheung) #55604
crypto:
  * graduate WebCryptoAPI Ed25519 and X25519 algorithms as stable (Filip Skokan) #56142
dgram:
  * (SEMVER-MINOR) support blocklist in udp (theanarkh) #56087
doc:
  * stabilize util.styleText (Rafael Gonzaga) #56265
  * move typescript support to active development (Marco Ippolito) #55536
  * add LJHarb to collaborators (Jordan Harband) #56132
  * (SEMVER-MINOR) add report version and history section (Chengzhong Wu) #56130
  * (SEMVER-MINOR) sort --report-exclude alphabetically (Rafael Gonzaga) #55788
doc,lib,src,test:
  * (SEMVER-MINOR) unflag sqlite module (Colin Ihrig) #55890
module:
  * (SEMVER-MINOR) only emit require(esm) warning under --trace-require-module (Joyee Cheung) #56194
  * (SEMVER-MINOR) add module.stripTypeScriptTypes (Marco Ippolito) #55282
net:
  * (SEMVER-MINOR) support blocklist in net.connect (theanarkh) #56075
  * (SEMVER-MINOR) add SocketAddress.parse (James M Snell) #56076
  * (SEMVER-MINOR) add net.BlockList.isBlockList(value) (James M Snell) #56078
  * (SEMVER-MINOR) support blocklist for net.Server (theanarkh) #56079
process:
  * (SEMVER-MINOR) deprecate `features.{ipv6,uv}` and `features.tls_*` (René) #55545
report:
  * (SEMVER-MINOR) fix typos in report keys and bump the version (Yuan-Ming Hsu) #56068
sqlite:
  * (SEMVER-MINOR) aggregate constants in a single property (Edigleysson Silva (Edy)) #56213
  * (SEMVER-MINOR) add `StatementSync.prototype.iterate` method (tpoisseau) #54213
src:
  * (SEMVER-MINOR) add cli option to preserve env vars on dr (Rafael Gonzaga) #55697
src,lib:
  * (SEMVER-MINOR) stabilize permission model (Rafael Gonzaga) #56201
util:
  * (SEMVER-MINOR) add sourcemap support to getCallSites (Marco Ippolito) #55589

PR-URL: #56329
Ceres6 pushed a commit to Ceres6/node that referenced this pull request Jan 13, 2025
Notable changes:

assert:
  * (SEMVER-MINOR) add partialDeepStrictEqual (Giovanni Bucci) nodejs#54630
cli:
  * (SEMVER-MINOR) implement --trace-env and --trace-env-[js|native]-stack (Joyee Cheung) nodejs#55604
crypto:
  * graduate WebCryptoAPI Ed25519 and X25519 algorithms as stable (Filip Skokan) nodejs#56142
dgram:
  * (SEMVER-MINOR) support blocklist in udp (theanarkh) nodejs#56087
doc:
  * stabilize util.styleText (Rafael Gonzaga) nodejs#56265
  * move typescript support to active development (Marco Ippolito) nodejs#55536
  * add LJHarb to collaborators (Jordan Harband) nodejs#56132
  * (SEMVER-MINOR) add report version and history section (Chengzhong Wu) nodejs#56130
  * (SEMVER-MINOR) sort --report-exclude alphabetically (Rafael Gonzaga) nodejs#55788
doc,lib,src,test:
  * (SEMVER-MINOR) unflag sqlite module (Colin Ihrig) nodejs#55890
module:
  * (SEMVER-MINOR) only emit require(esm) warning under --trace-require-module (Joyee Cheung) nodejs#56194
  * (SEMVER-MINOR) add module.stripTypeScriptTypes (Marco Ippolito) nodejs#55282
net:
  * (SEMVER-MINOR) support blocklist in net.connect (theanarkh) nodejs#56075
  * (SEMVER-MINOR) add SocketAddress.parse (James M Snell) nodejs#56076
  * (SEMVER-MINOR) add net.BlockList.isBlockList(value) (James M Snell) nodejs#56078
  * (SEMVER-MINOR) support blocklist for net.Server (theanarkh) nodejs#56079
process:
  * (SEMVER-MINOR) deprecate `features.{ipv6,uv}` and `features.tls_*` (René) nodejs#55545
report:
  * (SEMVER-MINOR) fix typos in report keys and bump the version (Yuan-Ming Hsu) nodejs#56068
sqlite:
  * (SEMVER-MINOR) aggregate constants in a single property (Edigleysson Silva (Edy)) nodejs#56213
  * (SEMVER-MINOR) add `StatementSync.prototype.iterate` method (tpoisseau) nodejs#54213
src:
  * (SEMVER-MINOR) add cli option to preserve env vars on dr (Rafael Gonzaga) nodejs#55697
src,lib:
  * (SEMVER-MINOR) stabilize permission model (Rafael Gonzaga) nodejs#56201
util:
  * (SEMVER-MINOR) add sourcemap support to getCallSites (Marco Ippolito) nodejs#55589

PR-URL: nodejs#56329
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. backport-open-v22.x Indicate that the PR has an open backport doc Issues and PRs related to the documentations. report Issues and PRs related to process.report.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants