Skip to content

Commit 08a0cd7

Browse files
authored
docs: drop the "Unreleased" remarks after 0.5.5 (#49)
Release 0.5.5 is published, so the pages stop marking its behavior as newer than the last release. This is the procedure of "Releasing" in docs/development.md, in English and Chinese: - changes.md: "Unreleased" becomes "0.5.5 (2026-11-10)", both entries get their pull request (#48), the sentence about the newest release "at the time of writing" goes, and "the new docs/managers.md" becomes "docs/managers.md". - README, README_CN: the paragraph that explains "Unreleased" goes. - managers, pnpm, troubleshooting: the "Unreleased: release 0.5.4 ..." remarks go. The Note row and the Warnings section now describe the two vfox generations without the marker. - scenarios.md: the outputs are from "the code that became release 0.5.5", and the shadowing bullet warns on both vfox generations with links to pnpm.md and managers.md, including link --detect. - mirror.md: the User-Agent example is vfox-nodejs/0.5.5. - source-build.md: the example URL of a released zip is 0.5.5. - Historical "Before 0.5.4" / "Since 0.5.4" sentences stay.
1 parent f6733ba commit 08a0cd7

16 files changed

Lines changed: 34 additions & 40 deletions

‎README.md‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,6 @@ node -v
4545
`vfox search nodejs` lists every release, with the npm that comes with it and a
4646
mark on the ones of an LTS line. In an interactive terminal it lets you pick one.
4747

48-
Behavior that only exists on `main` and not in the latest release is marked
49-
"Unreleased" in the pages below. [docs/changes.md](docs/changes.md) lists it, and
50-
[docs/source-build.md](docs/source-build.md) gets you `main`.
51-
5248
### Example: Ubuntu 26.04
5349

5450
```bash

‎README_CN.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,6 @@ node -v
3434

3535
`vfox search nodejs` 会列出每个版本及其自带的 npm,属于 LTS 版本线的版本带有标记。在交互式终端里可以从中选一个。
3636

37-
只存在于 `main`、还没进入最新发布版的行为,在下面各页里标有“未发布”。[docs/zh-CN/changes.md](docs/zh-CN/changes.md) 里列出了这些行为,想直接用上 `main`,见 [docs/zh-CN/source-build.md](docs/zh-CN/source-build.md)。
38-
3937
### 示例:Ubuntu 26.04
4038

4139
```bash

‎docs/changes.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,29 @@
44

55
What changed in each release, as a user notices it. GitHub's
66
[release pages](https://github.com/version-fox/vfox-nodejs/releases) list the
7-
pull requests. The newest release at the time of writing is 0.5.4, and `main` is
8-
ahead of it by everything under "Unreleased".
9-
[source-build.md](source-build.md) gets you those changes now.
7+
pull requests.
108

11-
## Unreleased
9+
## 0.5.5 (2026-11-10)
1210

1311
- On vfox 1.1.0 and later a `node` that shadows vfox's is reported by vfox
1412
itself with the plugin's hint, instead of the plugin's `Note:`. Release
1513
0.5.4 prints `Note: <shadowing node> comes before vfox in PATH, ...` from
1614
`PreUse` on every vfox, so with the new vfox the same shadowing prints
1715
both the core warning and the plugin note. The plugin now declares
1816
`PLUGIN.shadowHints` for pnpm, mise, asdf, nvm, Homebrew and winget (each
19-
with its handoff command and a link to `docs/pnpm.md` or the new
17+
with its handoff command and a link to `docs/pnpm.md` or
2018
`docs/managers.md`) and keeps its own `Note:` for vfox before 1.1.0
2119
only, which ignores the new metadata field. See [pnpm.md](pnpm.md),
2220
[managers.md](managers.md) and
23-
[troubleshooting.md](troubleshooting.md).
21+
[troubleshooting.md](troubleshooting.md)
22+
([#48](https://github.com/version-fox/vfox-nodejs/pull/48)).
2423
- `vfox link --detect nodejs` links the Node.js already on the machine
2524
instead of downloading another copy: the nvm, mise, asdf and Homebrew
2625
Cellar directories with a working `node` in them, and the winget
2726
directory on Windows, each under the plain release number the binary
2827
reports. Shims, pnpm's global runtime and copies without a versioned
29-
home are skipped. See [managers.md](managers.md).
28+
home are skipped. See [managers.md](managers.md)
29+
([#48](https://github.com/version-fox/vfox-nodejs/pull/48)).
3030

3131
## 0.5.4 (2026-11-04)
3232

‎docs/managers.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,7 @@ The symptom is always the same: `vfox use nodejs@<version>` prints
1313
the other manager's version, because its `node` comes before vfox's in
1414
`PATH` (`type -a node` lists it first). On vfox 1.1.0 and later vfox
1515
warns itself and appends the plugin's hint for the manager it
16-
recognizes; on older vfox the plugin prints its own `Note:`. Unreleased:
17-
release 0.5.4 prints the `Note:`; on vfox 1.1.0 and later the warning
18-
comes from vfox itself with the plugin's hint.
16+
recognizes; on older vfox the plugin prints its own `Note:`.
1917

2018
Pick at most one manager for `node` in a shell. The fastest way out is
2119
`vfox link --detect nodejs` (needs vfox 1.1.0 or later, which has

‎docs/mirror.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ with the `User-Agent` of Go's HTTP client, `Go-http-client/1.1`, and Huawei
9595
Cloud (HTTP 418), TUNA and BFSU (403) and USTC (204 with no content) answer that
9696
with an error page, or with nothing, in place of the package, which vfox saves.
9797
The plugin asks for `index.json` and `SHASUMS256.txt` with the `User-Agent`
98-
that vfox builds for it, `vfox/1.0.13 vfox-nodejs/0.5.4`, which all of them
98+
that vfox builds for it, `vfox/1.0.13 vfox-nodejs/0.5.5`, which all of them
9999
serve, and it has the download send the same one.
100100

101101
Addresses that only redirect are not listed: on 2026-11-03

‎docs/pnpm.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ Observed with pnpm 12.14.0 and vfox 1.0.12 in bash on Ubuntu.
4040
project lookup; `node` still runs pnpm's global Node.js, not vfox's.
4141

4242
`vfox use nodejs@<version>` warns when a `node` sits ahead of vfox
43-
this way, whichever tool put it there. Unreleased: release 0.5.4 prints
44-
the `Note:` below from the plugin; on vfox 1.1.0 and later the warning
45-
comes from vfox itself with the plugin's hint.
43+
this way, whichever tool put it there. On vfox 1.1.0 and later the warning
44+
comes from vfox itself with the plugin's hint; on older vfox the plugin
45+
prints the `Note:` below.
4646

4747
On vfox 1.1.0 and later:
4848

‎docs/scenarios.md‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ships with Windows 10 and 11, as well as in PowerShell 7, bash, zsh and fish.
1313

1414
Each case below says what you want, what to type and what you see. The outputs
1515
are from 2026-11-03 on Linux x64, with vfox 1.0.13 and the code that became
16-
release 0.5.4, and the home directory is shown as `/home/me`. The PowerShell
16+
release 0.5.5, and the home directory is shown as `/home/me`. The PowerShell
1717
lines were run in PowerShell 7.6.9 on Linux, except those that exist only on
1818
Windows: `Set-ExecutionPolicy` and the user-level
1919
`[Environment]::SetEnvironmentVariable`. Windows PowerShell 5.1 itself is not
@@ -129,8 +129,11 @@ What is different on Windows:
129129
policy of step 1, or the hook line is in the profile of the other PowerShell.
130130
- Only the first `node` in `PATH` runs. One from the installer of nodejs.org,
131131
from winget or Scoop, or from another version manager can sit in front of
132-
vfox's. `vfox use` then prints a note that names it and says that it comes
133-
before vfox in `PATH`, see [pnpm.md](pnpm.md). Uninstall the other one.
132+
vfox's. `vfox use` then warns about it: on vfox 1.1.0 and later vfox warns
133+
itself with the plugin's hint, on older vfox the plugin prints a note that
134+
names it and says that it comes before vfox in `PATH`, see [pnpm.md](pnpm.md)
135+
and [managers.md](managers.md). Uninstall the other one, or link it with
136+
`vfox link --detect nodejs`.
134137
- A `.nvmrc` that Windows PowerShell 5.1 writes with `>` is UTF-16, which the
135138
plugin reads, see [below](#writing-the-file-from-windows-powershell-51).
136139

‎docs/source-build.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ and `lib/` at its top level; that is the plugin package contract (see the
1515
[shared workflow documentation](https://github.com/version-fox/plugin-manifest-action)).
1616

1717
A released plugin zip URL also works as `--source`, e.g.
18-
`vfox add --source https://github.com/version-fox/vfox-nodejs/releases/download/v0.5.4/vfox-nodejs-0.5.4.zip`.
18+
`vfox add --source https://github.com/version-fox/vfox-nodejs/releases/download/v0.5.5/vfox-nodejs-0.5.5.zip`.
1919

2020
Prerequisites on all systems: [vfox](https://github.com/version-fox/vfox)
2121
itself plus `git`.

‎docs/troubleshooting.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -132,12 +132,12 @@ These are not errors.
132132
| `Note: Node.js versions below 16 do not support Apple Silicon (arm64), using x64 architecture with Rosetta 2` | macOS arm64 and a release before 16.0.0, see [platforms.md](platforms.md#macos) |
133133
| `Note: musl libc detected, installed node-v22.23.3-linux-x64-musl.tar.gz. See ...` | the plugin took the musl package, see [musl.md](musl.md) |
134134
| `Note: node-v18.20.8-linux-x64-musl.tar.gz is not listed in https://nodejs.org/dist/v18.20.8/, using unofficial musl build` | nodejs.org has no such musl package and the plugin takes it from unofficial-builds.nodejs.org |
135-
| ``Note: /home/me/.local/share/pnpm/bin/node comes before vfox in PATH, so `node` will not run nodejs@24.21.0. See ...`` | another `node` shadows vfox's on vfox before 1.1.0, see [pnpm.md](pnpm.md) for pnpm and [managers.md](managers.md) for mise, asdf, nvm, Homebrew and winget. Unreleased: release 0.5.4 prints this; on vfox 1.1.0 and later vfox warns itself (`node runs ... instead of nodejs@...`) and appends the plugin's hint |
135+
| ``Note: /home/me/.local/share/pnpm/bin/node comes before vfox in PATH, so `node` will not run nodejs@24.21.0. See ...`` | another `node` shadows vfox's on vfox before 1.1.0, see [pnpm.md](pnpm.md) for pnpm and [managers.md](managers.md) for mise, asdf, nvm, Homebrew and winget |
136136

137137
### Warnings from vfox itself
138138

139-
Unreleased: vfox 1.1.0 and later reports a shadowing `node` with the
140-
plugin's hint; release 0.5.4 prints the `Note:` above from the plugin.
139+
On vfox 1.1.0 and later vfox reports a shadowing `node` with the
140+
plugin's hint; on older vfox the plugin prints the `Note:` above.
141141

142142
| Warning | Meaning |
143143
| --- | --- |

‎docs/zh-CN/changes.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
[中文](changes.md) | [English](../changes.md)
44

5-
按发布版本列出用户能感受到的变化。GitHub 的 [Release 页面](https://github.com/version-fox/vfox-nodejs/releases)列出了对应的 PR。写这篇文档时最新的发布版是 0.5.4,`main` 比它多出“未发布”下面的所有内容。想现在就用上这些变化,见 [source-build.md](source-build.md)。
5+
按发布版本列出用户能感受到的变化。GitHub 的 [Release 页面](https://github.com/version-fox/vfox-nodejs/releases)列出了对应的 PR。
66

7-
## 未发布
7+
## 0.5.5(2026-11-10)
88

9-
- 在 vfox 1.1.0 及以后的版本里,遮蔽 vfox 的 `node` 由 vfox 自己报告,并附带插件的提示,不再由插件打印 `Note:`。0.5.4 会在所有 vfox 上从 `PreUse` 打印 `Note: <shadowing node> comes before vfox in PATH, ...`,所以在新 vfox 上,同一个遮蔽会同时打印核心警告和插件的提示。插件现在为 pnpm、mise、asdf、nvm、Homebrew 和 winget 声明 `PLUGIN.shadowHints`(各自的交接命令,以及指向 `docs/pnpm.md` 或新建 `docs/managers.md` 的链接),只在 1.1.0 之前的 vfox 上保留自己的 `Note:`,老 vfox 会忽略这个新的元数据字段。见 [pnpm.md](pnpm.md)、[managers.md](managers.md)和 [troubleshooting.md](troubleshooting.md)。
10-
- `vfox link --detect nodejs` 会把本机已有的 Node.js 链进来,不用再下载一份:装着可用 `node` 的 nvm、mise、asdf 和 Homebrew Cellar 目录,Windows 上还有 winget 目录,每个都用二进制自己报出的纯版本号命名。shim、pnpm 的全局运行时和没有版本化家目录的复制会被跳过。见 [managers.md](managers.md)。
9+
- 在 vfox 1.1.0 及以后的版本里,遮蔽 vfox 的 `node` 由 vfox 自己报告,并附带插件的提示,不再由插件打印 `Note:`。0.5.4 会在所有 vfox 上从 `PreUse` 打印 `Note: <shadowing node> comes before vfox in PATH, ...`,所以在新 vfox 上,同一个遮蔽会同时打印核心警告和插件的提示。插件现在为 pnpm、mise、asdf、nvm、Homebrew 和 winget 声明 `PLUGIN.shadowHints`(各自的交接命令,以及指向 `docs/pnpm.md` 或 `docs/managers.md` 的链接),只在 1.1.0 之前的 vfox 上保留自己的 `Note:`,老 vfox 会忽略这个新的元数据字段。见 [pnpm.md](pnpm.md)、[managers.md](managers.md)和 [troubleshooting.md](troubleshooting.md)([#48](https://github.com/version-fox/vfox-nodejs/pull/48))。
10+
- `vfox link --detect nodejs` 会把本机已有的 Node.js 链进来,不用再下载一份:装着可用 `node` 的 nvm、mise、asdf 和 Homebrew Cellar 目录,Windows 上还有 winget 目录,每个都用二进制自己报出的纯版本号命名。shim、pnpm 的全局运行时和没有版本化家目录的复制会被跳过。见 [managers.md](managers.md)([#48](https://github.com/version-fox/vfox-nodejs/pull/48))。
1111

1212
## 0.5.4(2026-11-04)
1313

0 commit comments

Comments
 (0)