From a281ca04986c6b57d1aff62320984ab18df31033 Mon Sep 17 00:00:00 2001 From: Stephen Zhou Date: Mon, 15 Apr 2024 01:42:43 +0800 Subject: [PATCH] docs: update --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3679edd..a60760a 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,9 @@ Run [release-it](https://github.com/release-it/release-it) with [pnpm](https://pnpm.io). -## Requirements +## Requirements with workaround -
Use pnpm and set packageManager in package.json correctly.
So that GitHub Action can set up pnpm correctly. You can manually select the pnpm version in the GitHub Action workflow file.
+
Use pnpm and set packageManager in package.json correctly.
So that GitHub Action can set up pnpm correctly. You can also manually setup the pnpm version in the GitHub Action workflow file.
Use Conventional Commits and follow Semantic Versioning .
So that it can provide recommended version in CI. It's OK to not follow this rule if you manually decide the next version and disable GitHub release.