This repository deploys to 2 stacks (one production and one development) via github actions. These deployments are intended to be services in beta for demonstration in NASA's VEDA project.
The production stack will be deployed when main is tagged (aka "released"). The production stack has the domain https://prod-titiler-xarray.delta-backend.com.
The development stack will be deployed upon pushes to the dev and main branches. The development stack will have the domain https://dev-titiler-xarray.delta-backend.com.
- PRs are made to
devbranch. PRs should include tests and documentation. pytest should succeed before merging. If appropriate, changes should be added to the CHANGELOG.md file under "Next release". - Once merged, https://dev-titiler-xarray.delta-backend.com will be deployed and should be manually tested.
Before releasing, it is recommended to run benchmarks to compare performance between the development and production deployments. Run benchmarks between prod and dev via the Run Benchmarks workflow in the tile-benchmarking repo. Once the workflow completes, inspect the output of the "Upload results to S3" step for each environment to get the directory prefix for the past run. The output can be reviewed using the https://github.com/developmentseed/tile-benchmarking/blob/main/03-e2e/compare-prod-dev.ipynb notebook.
- When it is time to release changes to production, add changes to CHANGELOG.md under a new release version and commit to dev. The
devbranch will be merged to themainbranch (no PR necessary). - The development deployment is updated to the latest commit on main. This should be manually tested again.
- When ready, a release will be created on main by creating a tag. This will trigger the production deployment.
- The production deployment (https://prod-titiler-xarray.delta-backend.com) should be manually tested.