Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
13 changes: 12 additions & 1 deletion packages/spine-validation-ts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down