Release Checklist
This guide documents the procedures and checklists required when building and releasing a new version of the stac-gis platform.
๐ท๏ธ Versioning Schemeโ
We follow Semantic Versioning (SemVer):
- MAJOR (
X.0.0): Backwards-incompatible API changes or major layout updates. - MINOR (
0.Y.0): Added features or packages in a backwards-compatible manner. - PATCH (
0.0.Z): Backwards-compatible bug fixes or minor documentation corrections.
๐ฆ Docker Container Release Buildโ
To package container builds for release:
-
Verify Local Compilations: Ensure all Docker images build cleanly:
docker-compose build --no-cache -
Publish Images: Tag and push images to the OpenGeoHub Docker Hub or Codeberg:
# Tag imagesdocker tag stac-gis-api:latest opengeohub/stac-gis-api:v1.2.0docker tag stac-gis-web:latest opengeohub/stac-gis-web:v1.2.0# Push to repository registrydocker push opengeohub/stac-gis-api:v1.2.0docker push opengeohub/stac-gis-web:v1.2.0
๐ Release Checklistโ
Before marking a Codeberg Release:
- All unit and integration test suites pass successfully.
- Database schema migrations run successfully with
alembic upgrade head. - Documentation site is updated with any new API endpoints, config keys, or package layouts.
- Release notes are drafted, summarizing key features, fixed issues, and breaking changes.