feat: Add Docker image versioning & DockerHub snapshot/restore workflow#316
Merged
AnkushMalaker merged 6 commits intoSimpleOpenSoftware:devfrom Feb 28, 2026
Merged
Conversation
Contributor
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
…tions - Add image: fields with CHRONICLE_REGISTRY/CHRONICLE_TAG env vars to all custom services in docker-compose files (backends/advanced, asr-services, speaker-recognition, havpe-relay) - Create scripts/push-images.sh to tag and push local images to DockerHub - Create scripts/pull-images.sh to pull and retag images for local use - Add --use-prebuilt TAG flag to services.py start command; sets CHRONICLE_REGISTRY and CHRONICLE_TAG env vars and disables build - Add unit tests for image versioning changes Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
… image tags
- Modified `docker-compose.yml` files for ASR services and speaker recognition to utilize `${CHRONICLE_REGISTRY}` and `${CHRONICLE_TAG}` for image definitions, enhancing flexibility in image management.
- Updated `push-images.sh` script to include the new ASR service images, ensuring they are correctly tagged and pushed to the registry.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
image:fields withCHRONICLE_REGISTRY/CHRONICLE_TAGenv-var substitution to every custom service in the four docker-compose files (backends/advanced,extras/asr-services,extras/speaker-recognition,extras/havpe-relay)scripts/push-images.sh— tags and pushes locally-built images to DockerHub, records a release entry inscripts/releases.jsonscripts/pull-images.sh— pulls images from DockerHub and retags them so docker-compose can find them by version--use-prebuilt TAGflag toservices.py start— setsCHRONICLE_REGISTRY/CHRONICLE_TAGand skips the build step, so pulled images are used directlyMotivation
When something breaks after building from source there was no way to quickly roll back. This PR adds a snapshot → push → restore workflow:
How it works
CHRONICLE_REGISTRY/CHRONICLE_TAGenv vars (both default to empty/latest)When not set, docker-compose behaves exactly as before — images are named
chronicle-backend:latestetc. and are built locally.When set (e.g.
CHRONICLE_REGISTRY=myuser/CHRONICLE_TAG=v1.2.0), docker-compose resolves image names tomyuser/chronicle-backend:v1.2.0and uses the pre-pulled image without rebuilding.push-images.sh:latesttag alongside the versioned tagscripts/releases.jsonpull-images.shCHRONICLE_TAG=v1.2.0works correctly--use-prebuilt TAGinservices.pyDOCKERHUB_USERNAMEenv var; exits with a clear error if missingCHRONICLE_REGISTRYandCHRONICLE_TAGinto the subprocess environment before docker-compose runsbuild=Falseregardless of whether--buildis also passedTest plan
./start.sh --build— verify services start normally (no behaviour change without env vars)DOCKERHUB_USERNAME=testuser ./scripts/push-images.sh v0.1-test "test"without any images built — verify yellow warnings, non-zero exitDOCKERHUB_USERNAME=testuser ./scripts/pull-images.sh v0.1-test— verify pull + retagDOCKERHUB_USERNAME=testuser ./start.sh --use-prebuilt v0.1-test— verify services start without a build step./start.sh --use-prebuilt v0.1-test(no DOCKERHUB_USERNAME) — verify clear error, no containers startedcd tests && uv run pytest unit/test_docker_image_versioning.py -v— all 35 tests pass🤖 Generated with Claude Code