Skip to content

Commit

Permalink
Add instructions to run the generate script (#50)
Browse files Browse the repository at this point in the history
  • Loading branch information
slinkydeveloper authored Jun 30, 2023
1 parent cd99e95 commit cc2b2c5
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,23 @@ In order to release the documentation you have to push a tag of the form `vX.Y.Z
This will trigger the [release workflow](.github/workflows/release.yml), which builds and publishes and new `restatedev/documentation:vX.Y.Z` container image.
Moreover, it will create a draft [release on Github](https://github.com/restatedev/documentation/releases) that needs manual approval.

### Updating the schemas

To update the configuration schemas, the default configuration and the Meta OpenAPI document,
clone [Restate](https://github.com/restatedev/restate/) and execute the following:

```shell
$ ./tools/generate.sh <PATH to Restate repo clone>
```

### Upgrading Typescript SDK version

Update the `TYPESCRIPT_SDK_VERSION` value in `docusaurus.config.js`

### Upgrading Restate runtime version

Update the `RESTATE_DIST_VERSION` value in `docusaurus.config.js`

### Upgrading Tour version

Update the `TOUR_VERSION` value in `docusaurus.config.js`

0 comments on commit cc2b2c5

Please sign in to comment.