fix(runtime): sanitize project names for Docker Compose compatibility #1
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
Docker Compose requires project names to consist only of lowercase alphanumeric characters, hyphens, and underscores. Projects with periods (e.g., 'tektonio.app') would fail with an error. Changes: - Added sanitize_docker_project_name() function to convert invalid names - Applied sanitization to COMPOSE_PROJECT_NAME environment variable - Added validation during 'weft init' with interactive prompt - Added 11 unit tests + 1 integration test (100% coverage) - Updated troubleshooting.md with Docker Compose name requirements - Updated cli-reference.md to document naming constraints The sanitization: - Converts to lowercase - Replaces invalid characters with hyphens - Removes leading/trailing hyphens/underscores - Provides fallback for edge cases Fixes issue where 'weft up' would fail with: "invalid project name: must consist only of lowercase alphanumeric characters, hyphens, and underscores"
bankyadam
force-pushed
the
fix/docker-compose-project-name-sanitization
branch
from
eef5fab to
1131b71
Compare
- Simplified sanitize_docker_project_name() docstring (1 line) - Removed 'tektonio.app' from tests, use generic 'example.app' - Removed troubleshooting section (issue is now fixed automatically)
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.
Docker Compose requires project names to consist only of lowercase alphanumeric characters, hyphens, and underscores. Projects with periods (e.g., 'example.app') would fail with an error.
Changes:
The sanitization:
Fixes issue where 'weft up' would fail with:
"invalid project name: must consist only of lowercase alphanumeric characters, hyphens, and underscores"