From 0eb0e970826653e8af98de91bec007fbd58a23e0 Mon Sep 17 00:00:00 2001 From: Karl Horky Date: Thu, 4 Jul 2024 10:37:24 +0200 Subject: [PATCH] Add readme example for omitting `version` (#134) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Add readme example for omitting `version` * docs: more detailed explanations --------- Co-authored-by: Khải --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index aff3cb7..d5d17eb 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,9 @@ Location of `pnpm` and `pnpx` command. ## Usage example -### Just install pnpm +### Install only pnpm without `packageManager` + +This works when the repo either doesn't have a `package.json` or has a `package.json` but it doesn't specify `packageManager`. ```yaml on: @@ -77,6 +79,23 @@ jobs: version: 8 ``` +### Install only pnpm with `packageManager` + +Omit `version` input to use the version in the [`packageManager` field in the `package.json`](https://nodejs.org/api/corepack.html). + +```yaml +on: + - push + - pull_request + +jobs: + install: + runs-on: ubuntu-latest + + steps: + - uses: pnpm/action-setup@v4 +``` + ### Install pnpm and a few npm packages ```yaml