feature: simplifying the release process, sronger admin key - updated docs. #65
Conversation
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
Contributor
There was a problem hiding this comment.
Pull request overview
This PR modernizes the release and deployment process by introducing a unified Docker Compose-based workflow with pre-built images hosted on Docker Hub. The changes improve security (enforcing 32-character admin keys with constant-time comparison), simplify the release process (replacing platform-specific Makefile targets with a Python script), and update documentation accordingly.
Key Changes
- New Python script (
scripts/package_release.py) to automate release packaging, replacing Windows/Linux-specific Makefile targets - Security enhancements: 32-character minimum for admin keys and constant-time comparison for authentication
- Docker Compose files now include Docker Hub image references (
:api-latest,:worker-latest,:agentic-latest,:comfy-latest) alongside build configurations
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
scripts/package_release.py |
New Python script to automate creation of release packages (tarball with docker-compose files and clients) |
docker-compose.yml |
Adds Docker Hub image references for all services to support pre-built image deployment |
docker-compose.release.yml |
Removed - functionality replaced by unified docker-compose.yml |
docker-compose.comfy.yml |
Adds Docker Hub image reference for ComfyUI sidecar service |
api/common/config.py |
Enforces 32-character minimum for admin key, removes default value and validation warning |
api/common/auth.py |
Implements constant-time comparison for admin key validation and updates error message |
README.md |
Documents how to generate secure admin keys and clarifies release process |
Makefile |
Simplifies release targets to use new Python script, changes default VERSION to "latest", removes platform-specific targets |
DEPLOYMENT.md |
Adds documentation for optional ComfyUI sidecar deployment |
.github/workflows/release.yml |
Adds build job for agentic service, updates release packaging command, adds disk space reclaimer to API build job |
.github/workflows/it-tests.yml |
Updates admin key in CI to meet 32-character requirement |
JoeGaffney
changed the title
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.
No description provided.