diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index f6126ed..267f227 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -30,7 +30,7 @@ jobs: - name: Build validation package run: npm run build --workspace=@spine-event-engine/validation-ts - # This runs: buf generate → patch → tsc (via prepublishOnly) - name: Perform publishing to NPM registry - run: npm publish --workspace=@spine-event-engine/validation-ts + # The version is still a `snapshot`, so NPM requires it to be tagged accordingly. + run: npm publish --workspace=@spine-event-engine/validation-ts --tag snapshot diff --git a/README.md b/README.md index 89d2d3e..25caee2 100644 --- a/README.md +++ b/README.md @@ -72,10 +72,21 @@ with other Protobuf code generators. ### Installation +This package is currently published as a **pre-release (snapshot)** version. +Install it using the `@snapshot` dist-tag: + +```bash +npm install @spine-event-engine/validation-ts@snapshot @bufbuild/protobuf +``` + +To install a specific snapshot version: + ```bash -npm install @spine-event-engine/validation-ts @bufbuild/protobuf +npm install @spine-event-engine/validation-ts@2.0.0-snapshot.3 @bufbuild/protobuf ``` +> **Note:** This library is in active development and therefore it is published as a snapshot. + ### Usage Guide #### Step 1: Configure Buf for code generation diff --git a/packages/spine-validation-ts/README.md b/packages/spine-validation-ts/README.md index 5245802..89945c2 100644 --- a/packages/spine-validation-ts/README.md +++ b/packages/spine-validation-ts/README.md @@ -33,10 +33,21 @@ The package includes: ## Installation +This package is currently published as a **pre-release (snapshot)** version. +Install it using the `@snapshot` dist-tag: + +```bash +npm install @spine-event-engine/validation-ts@snapshot @bufbuild/protobuf +``` + +To install a specific snapshot version: + ```bash -npm install @spine-event-engine/validation-ts @bufbuild/protobuf +npm install @spine-event-engine/validation-ts@2.0.0-snapshot.3 @bufbuild/protobuf ``` +> **Note:** This library is in active development and therefore it is published as a snapshot. + ### Setup Code Generation Ensure your project uses [Buf](https://buf.build/) with the Protobuf-ES plugin.