Skip to content

Commit bab1242

Browse files
committed
docs: Add note to readme
1 parent 80df0c5 commit bab1242

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,4 +202,6 @@ npm run storage-to-diagrams
202202
- Create a new commit with the version bump.
203203
- Generate the corresponding Git tag.
204204
205-
There is no need to create a full GitHub release for prerelease versions, a Git tag is sufficient.
205+
Running this command ensures that the version in package.json matches the Git tag. This alignment is required for correct package publication and to automatically determine the appropriate npm dist tag (see [publish.yml](../.github/workflows/publish.yml)).
206+
207+
> Note: There is no need to create a full GitHub release for prerelease versions, a Git tag is sufficient.

0 commit comments

Comments
 (0)