Skip to content

Commit

Permalink
docs: improve release docs
Browse files Browse the repository at this point in the history
  • Loading branch information
agierlicki committed Jan 22, 2025
1 parent 18046aa commit 32b5a5c
Showing 1 changed file with 14 additions and 6 deletions.
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,18 +132,26 @@ jobs:
<details>
<summary>The action can be used to create release PR and publish releases for repos using PNPM and <a href="https://github.com/changesets/changesets">changesets</a>.</summary>
> [!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/[email protected]
uses: Staffbase/gha-workflows/.github/workflows/[email protected]
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'
```
</details>
Expand Down

0 comments on commit 32b5a5c

Please sign in to comment.