Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tillrohrmann authored Dec 2, 2023
1 parent 9db6a97 commit d8345bf
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,20 +49,18 @@ The `main` branch of the documentation is continuously deployed at https://main.
Before releasing the documentation, update schemas and version of Restate artifacts, either:

* Automatically by executing the _Pre-release updates_ workflow.
* Manually, as described below.
* Manually, as described [here](#manually-update-the-schemas).

Once the branch `main` is ready to be released, merge `main` in `production` and push it, together with the release tag. E.g:
Once the branch `main` is ready to be released, create and push the release tag:

```shell
git checkout production
git merge origin/main
git tag v0.3.0
git push
git checkout main
git tag -m "Documentation v0.3.0" v0.3.0
git push --tags
```

Once pushed the update to the `production` branch, the website deployment will be updated.
The tag triggers the build of the new `restatedev/documentation:vX.Y.Z` container image and creates a draft [release on Github](https://github.com/restatedev/documentation/releases) that needs manual approval.
Moreover, it will push the latest `main` to the `production` branch which triggers the deployment of the documentation.

### Manually update the schemas

Expand Down

0 comments on commit d8345bf

Please sign in to comment.