feat: Add Docker release automation and standardize naming #9
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
## Changes ### GitHub Actions Workflow - Add docker-release.yml workflow triggered by v* tags - Builds multi-platform images (amd64/arm64) for GHCR - Semantic versioning: generates tags for full version, major.minor, major, and latest - Separate init container images tagged with -init suffix ### Variable Naming Standardization - Rename BIRDNET_DATA_VOLUME → BIRDNETPI_DATA_VOLUME - Rename birdnet-data → birdnetpi-data (production volume) - Rename birdnet-test-data → birdnetpi-test-data (test volume) - Update all references across docker-compose, CI workflows, and tests - Rationale: BIRDNETPI is the project name, BIRDNET is the underlying tool ### Production Docker Compose - Add docker-compose.production.yml for using published images - Supports both Docker volumes and bind mounts (Home Assistant compatible) - Simplified configuration for production deployments ### Init Container - Confirmed init container is required for production deployments - Handles asset downloads (~99MB), permissions, and config initialization - Works seamlessly with both volume types ### Testing - Update E2E test configuration for new variable names - All expensive tests passing (8/8) - Docker build and deployment verified
- Quote variables to prevent globbing and word splitting
- Use command grouping for multiple redirects to same file
- Addresses actionlint/shellcheck warnings:
- SC2086: Quote variables
- SC2129: Use { cmd1; cmd2; } >> file pattern
mverteuil
force-pushed
the
feature/docker-releases
branch
from
9c382ee to
8cf31e7
Compare
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
This PR adds automated Docker image publishing for releases and standardizes variable naming to use the
BIRDNETPI_*prefix consistently.Changes
🚀 Docker Release Automation
.github/workflows/docker-release.ymlv(e.g.,v2.0.0,v2.1.0-alpha)ghcr.io/mverteuil/birdnet-pilinux/amd64andlinux/arm64-initsuffix📦 Production Docker Compose
docker-compose.production.yml🏷️ Variable Naming Standardization
Renamed environment variables and volumes to use
BIRDNETPI_*prefix:BIRDNET_DATA_VOLUME→BIRDNETPI_DATA_VOLUMEbirdnet-data→birdnetpi-data(production volume)birdnet-test-data→birdnetpi-test-data(test volume)Rationale: BIRDNETPI is the project name; BIRDNET is the underlying analysis tool.
Files updated:
docker-compose.yml.github/workflows/ci.ymltests/e2e/conftest.py🔧 Init Container
Confirmed the init container is required for production deployments:
Testing
Deployment Impact
For existing users: No breaking changes to development workflow. The variable name changes only affect:
For new deployments: Users can now pull pre-built images from GHCR instead of building locally.