diff --git a/README.md b/README.md index 3b43920..82101a1 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,12 @@ This is the backend for the [HyperTuner Cloud](https://github.com/hyper-tuner/hy - deployment scripts / **Docker** and docker compose files - migration scripts and guides +## Upgrading + +Some versions will contain breaking changes. + +If you are upgrading from a previous version, please read the [UPGRADE.md](UPGRADE.md) file. + ## Setting up your instance Use provider Docker files from the `/docker` directory or just grab the binary from the [Releases](https://github.com/hyper-tuner/cloud-backend/releases) page. diff --git a/UPGRADE.md b/UPGRADE.md new file mode 100644 index 0000000..5f69297 --- /dev/null +++ b/UPGRADE.md @@ -0,0 +1,9 @@ +# Upgrade guide + +## From v1.0.0 to v1.0.1 + +This version adds to new custom endpoints for fetching tune and ini file. + +1. get the new binary and run `cloud-backend`, make sure everything works as it was before (don't forget to backup `pb_data` data) +2. upgrade frontend to `v1.0.1` +3. import new schema