Skip to content

Commit

Permalink
Add documentation to update buf.lock
Browse files Browse the repository at this point in the history
  • Loading branch information
slinkydeveloper committed Dec 15, 2023
1 parent e033b2f commit c3d84ac
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,12 @@ Launch a sample program (requires no build)
npm run example
```

### Update the proto descriptors

```shell
npm run proto
```

### Testing end-to-end with Restate Runtime

This requires the [Docker Engine](https://docs.docker.com/engine/install/) to launch the Restate runtime for testing.
Expand All @@ -135,6 +141,10 @@ curl -X POST http://localhost:8080/greeter/greet -H 'content-type: application/j

# Releasing the package

## Pre-release

Before release, make sure the `buf.lock` of the proto descriptors is updated. See [Update the proto descriptors](#update-the-proto-descriptors).

## Releasing via release-it

Releasing a new npm package from this repo requires:
Expand Down

0 comments on commit c3d84ac

Please sign in to comment.