Skip to content

Commit 0977fd9

Browse files
authored
docs: Update README to include devEngines.packageManager (#273)
Support added in #211 and #256
1 parent 48261ac commit 0977fd9

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

‎README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Input and output changes:
6262

6363
Version of pnpm to install.
6464

65-
**Optional** when there is a [`packageManager` field in the `package.json`](https://nodejs.org/api/corepack.html).
65+
**Optional** when there is a [`packageManager` or `devEngines.packageManager` field in the `package.json`](https://nodejs.org/api/corepack.html).
6666

6767
otherwise, this field is **required** It supports npm versioning scheme, it could be an exact version (such as `10.9.8`), or a version range (such as `10`, `10.x.x`, `10.9.x`, `^10.9.8`, `*`, etc.), or `latest`.
6868

@@ -102,7 +102,7 @@ If `run_install` is a YAML string representation of either an object or an array
102102

103103
### `package_json_file`
104104

105-
**Optional** (_type:_ `string`, _default:_ `package.json`) File path to the `package.json`/[`package.yaml`](https://github.com/pnpm/pnpm/pull/1799) to read "packageManager" configuration.
105+
**Optional** (_type:_ `string`, _default:_ `package.json`) File path to the `package.json`/[`package.yaml`](https://github.com/pnpm/pnpm/pull/1799) to read `packageManager` or `devEngines.packageManager` configuration.
106106

107107
### `standalone`
108108

@@ -124,7 +124,7 @@ Location of `pnpm` and `pnpx` command.
124124

125125
### Install only pnpm without `packageManager`
126126

127-
This works when the repo either doesn't have a `package.json` or has a `package.json` but it doesn't specify `packageManager`.
127+
This works when the repo either doesn't have a `package.json` or has a `package.json` but it doesn't specify `packageManager` or `devEngines.packageManager`.
128128

129129
```yaml
130130
on:
@@ -143,7 +143,7 @@ jobs:
143143

144144
### Install only pnpm with `packageManager`
145145

146-
Omit `version` input to use the version in the [`packageManager` field in the `package.json`](https://nodejs.org/api/corepack.html).
146+
Omit `version` input to use the version in the [`packageManager` or `devEngines.packageManager` field in the `package.json`](https://nodejs.org/api/corepack.html).
147147

148148
```yaml
149149
on:

0 commit comments

Comments
 (0)