From 32b5a5ce798f40c070e81f4527c6a013c38008bf Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Wed, 22 Jan 2025 11:44:01 +0100 Subject: [PATCH] docs: improve release docs --- README.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f8f02a8..e28acc8 100644 --- a/README.md +++ b/README.md @@ -132,18 +132,26 @@ jobs:
The action can be used to create release PR and publish releases for repos using PNPM and changesets. -> [!NOTE] -> Make sure you have `@changesets/cli` installed as a dev-dependency in your project! +⚠️ Make sure you have `@changesets/cli` installed as a dev-dependency in your project! ```yml -name: Changeset Check +name: Release + on: - pull_request: - types: [opened, reopened, synchronize] + push: + branches: + - main jobs: changeset-check: - uses: Staffbase/gha-workflows/.github/workflows/template_changeset_check@v7.0.0 + uses: Staffbase/gha-workflows/.github/workflows/template_changeset_release@v7.0.0 + with: + # optional, defaults to `.nvmrc` + node-version-file: '.node-version' + # optional, defaults to `pnpm release` + publish-script: 'pnpm publish' + # optional, defaults to `pnpm changeset version` + version-script: 'pnpm version' ```