node icon indicating copy to clipboard operation
node copied to clipboard

Published 20 hours ago • verified publisher icon nodejs

doc: mention `corepack prepare` supports dist-tag

Open mrienstra opened this issue 2 years ago • 2 comments

corepack prepare yarn@latest --activate is a useful alternative to corepack prepare [email protected] --activate, added in Corepack v0.120.

Latest pnpm docs (1, 2) mention this option, seems like Node.js Corepack docs should too!

With Node.js v16.17 or newer, you may install the latest version of pnpm by just specifying the tag:

corepack prepare pnpm@latest --activate

Oh, hmm, Node.js v18.6.0 is the oldest version with corepack >= 0.12.0, is that worth mentioning?

(For v16: v16.17.0 is the oldest version with corepack >= 0.12.0)

I can see this that:

<div class="api_metadata">
  <span>Added in: v16.9.0, v14.19.0</span>
</div>

is being added with:

<!-- YAML
added:
  - v16.9.0
  - v14.19.0
-->

Not sure if that can also be used further down to show when dist-tag support was added...

Double oh, I thought I was somehow specifically editing the v18 version of the docs, but now I'm not sure how that works. docs/latest-v16.x/api/corepack & docs/latest-v18.x/api/corepack are identical, and "Options" --> "Edit on GitHub" leads to the same place for both versions.

Ah, OK, I see: https://github.com/nodejs/node/blob/v18.x/doc/api/corepack.md https://github.com/nodejs/node/blob/v16.x/doc/api/corepack.md https://github.com/nodejs/node/blob/v14.x/doc/api/corepack.md (includes "simply", v18 & v16 do not)

Anyhoo, advice on how best to show when dist-tag support was added would be welcome.

mrienstra avatar Sep 15 '22 02:09 mrienstra

Note to self: read doc/contributing/pull-requests.md#commit-message-guidelines more carefully next time. 🤦

mrienstra avatar Sep 15 '22 06:09 mrienstra

Commit Queue failed
- Loading data for nodejs/node/pull/44646
✔  Done loading data for nodejs/node/pull/44646
----------------------------------- PR info ------------------------------------
Title      doc: mention `corepack prepare` supports dist-tag (#44646)
Author     Michael Rienstra  (@mrienstra, first-time contributor)
Branch     mrienstra:patch-1 -> nodejs:main
Labels     doc, author ready
Commits    5
 - doc: corepack prepare: dist-tag option
 - collapsed reference link as per @aduh95
 - docs: several examples, as per @aduh95
 - docs: simplify, just say 'tag or range', drop link
 - docs: corepack: revert ref re-ordering
Committers 1
 - Michael Rienstra 
PR-URL: https://github.com/nodejs/node/pull/44646
Reviewed-By: Antoine du Hamel 
Reviewed-By: Akhil Marsonya 
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/44646
Reviewed-By: Antoine du Hamel 
Reviewed-By: Akhil Marsonya 
--------------------------------------------------------------------------------
   ℹ  This PR was created on Thu, 15 Sep 2022 02:48:48 GMT
   ✔  Approvals: 2
   ✔  - Antoine du Hamel (@aduh95) (TSC): https://github.com/nodejs/node/pull/44646#pullrequestreview-1110999243
   ✔  - Akhil Marsonya (@marsonya): https://github.com/nodejs/node/pull/44646#pullrequestreview-1111492348
   ✖  Last GitHub CI failed
   ℹ  Green GitHub CI is sufficient
--------------------------------------------------------------------------------
   ✔  Aborted `git node land` session in /home/runner/work/node/node/.ncu
https://github.com/nodejs/node/actions/runs/3076549334

nodejs-github-bot avatar Sep 18 '22 09:09 nodejs-github-bot

Commit Queue failed
- Loading data for nodejs/node/pull/44646
✔  Done loading data for nodejs/node/pull/44646
----------------------------------- PR info ------------------------------------
Title      doc: mention `corepack prepare` supports dist-tag (#44646)
Author     Michael Rienstra  (@mrienstra, first-time contributor)
Branch     mrienstra:patch-1 -> nodejs:main
Labels     doc, author ready
Commits    5
 - doc: corepack prepare: dist-tag option
 - collapsed reference link as per @aduh95
 - docs: several examples, as per @aduh95
 - docs: simplify, just say 'tag or range', drop link
 - docs: corepack: revert ref re-ordering
Committers 1
 - Michael Rienstra 
PR-URL: https://github.com/nodejs/node/pull/44646
Reviewed-By: Antoine du Hamel 
Reviewed-By: Akhil Marsonya 
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/44646
Reviewed-By: Antoine du Hamel 
Reviewed-By: Akhil Marsonya 
--------------------------------------------------------------------------------
   ℹ  This PR was created on Thu, 15 Sep 2022 02:48:48 GMT
   ✔  Approvals: 2
   ✔  - Antoine du Hamel (@aduh95) (TSC): https://github.com/nodejs/node/pull/44646#pullrequestreview-1110999243
   ✔  - Akhil Marsonya (@marsonya): https://github.com/nodejs/node/pull/44646#pullrequestreview-1111492348
   ✔  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
   a2fb3f9785..80270994d6  main       -> origin/main
✔  origin/main is now up-to-date
main is out of sync with origin/main. Mismatched commits:
 - 123babc540 lib: enable global CustomEvent by default
 - 80270994d6 lib: enable global CustomEvent by default
--------------------------------------------------------------------------------
HEAD is now at 80270994d6 lib: enable global CustomEvent by default
   ✔  Reset to origin/main
- Downloading patch for 44646
From https://github.com/nodejs/node
 * branch                  refs/pull/44646/merge -> FETCH_HEAD
✔  Fetched commits as 80270994d6ba..3feef218585d
--------------------------------------------------------------------------------
[main 24fcc4797e] doc: corepack prepare: dist-tag option
 Author: Michael Rienstra 
 Date: Wed Sep 14 18:57:12 2022 -0700
 1 file changed, 6 insertions(+)
[main f31a17dc4f] collapsed reference link as per @aduh95
 Author: Michael Rienstra 
 Date: Thu Sep 15 11:24:50 2022 -0700
 1 file changed, 6 insertions(+), 5 deletions(-)
[main 9339b61aa7] docs: several examples, as per @aduh95
 Author: Michael Rienstra 
 Date: Thu Sep 15 16:22:22 2022 -0700
 1 file changed, 2 insertions(+), 1 deletion(-)
[main 1353268813] docs: simplify, just say 'tag or range', drop link
 Author: Michael Rienstra 
 Date: Thu Sep 15 16:41:50 2022 -0700
 1 file changed, 1 insertion(+), 2 deletions(-)
[main 2568d51925] docs: corepack: revert ref re-ordering
 Author: Michael Rienstra 
 Date: Fri Sep 16 10:18:59 2022 -0700
 1 file changed, 4 insertions(+), 4 deletions(-)
   ✔  Patches applied
There are 5 commits in the PR. Attempting autorebase.
Rebasing (2/10)

Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
doc: corepack prepare: dist-tag option


corepack prepare yarn@latest --activate is a useful alternative to
corepack prepare [email protected] --activate


PR-URL: https://github.com/nodejs/node/pull/44646
Reviewed-By: Antoine du Hamel [email protected]
Reviewed-By: Akhil Marsonya [email protected]


[detached HEAD 5555af4be1] doc: corepack prepare: dist-tag option
Author: Michael Rienstra [email protected]
Date: Wed Sep 14 18:57:12 2022 -0700
1 file changed, 6 insertions(+)
Rebasing (3/10)
Rebasing (4/10)


Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
collapsed reference link as per @aduh95


Sorted reference links using this pattern:
/^\[[^\w]*(.+?)\]: /


PR-URL: https://github.com/nodejs/node/pull/44646
Reviewed-By: Antoine du Hamel [email protected]
Reviewed-By: Akhil Marsonya [email protected]


[detached HEAD a3b221903d] collapsed reference link as per @aduh95
Author: Michael Rienstra [email protected]
Date: Thu Sep 15 11:24:50 2022 -0700
1 file changed, 6 insertions(+), 5 deletions(-)
Rebasing (5/10)
Rebasing (6/10)


Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
docs: several examples, as per @aduh95


PR-URL: https://github.com/nodejs/node/pull/44646
Reviewed-By: Antoine du Hamel [email protected]
Reviewed-By: Akhil Marsonya [email protected]


[detached HEAD b9c1665e01] docs: several examples, as per @aduh95
Author: Michael Rienstra [email protected]
Date: Thu Sep 15 16:22:22 2022 -0700
1 file changed, 2 insertions(+), 1 deletion(-)
Rebasing (7/10)
Rebasing (8/10)


Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
docs: simplify, just say 'tag or range', drop link


PR-URL: https://github.com/nodejs/node/pull/44646
Reviewed-By: Antoine du Hamel [email protected]
Reviewed-By: Akhil Marsonya [email protected]


[detached HEAD 9a74a782ef] docs: simplify, just say 'tag or range', drop link
Author: Michael Rienstra [email protected]
Date: Thu Sep 15 16:41:50 2022 -0700
1 file changed, 1 insertion(+), 2 deletions(-)
Rebasing (9/10)
Rebasing (10/10)


Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
docs: corepack: revert ref re-ordering


PR-URL: https://github.com/nodejs/node/pull/44646
Reviewed-By: Antoine du Hamel [email protected]
Reviewed-By: Akhil Marsonya [email protected]


[detached HEAD 60f39cbd72] docs: corepack: revert ref re-ordering
Author: Michael Rienstra [email protected]
Date: Fri Sep 16 10:18:59 2022 -0700
1 file changed, 4 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/3216159148

nodejs-github-bot avatar Oct 10 '22 00:10 nodejs-github-bot

Landed in https://github.com/nodejs/node/commit/4e659be9f8008db9539470e0b33bed6ab5b913b0

aduh95 avatar Oct 10 '22 00:10 aduh95