Replace stub/regex with symfony/yaml for compose.yaml manipulation#37
Merged
Replace stub/regex with symfony/yaml for compose.yaml manipulation#37
Conversation
Co-Authored-By: Ryo Kobayashi <cuba6vst@gmail.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Co-Authored-By: Ryo Kobayashi <cuba6vst@gmail.com>
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.
Replace stub/regex with symfony/yaml for compose.yaml manipulation
Summary
Replaces the fragile stub file + regex/string replacement approach for modifying
compose.yamlwith proper YAML parsing and dumping viasymfony/yaml.Before: Raw text manipulation using
preg_replaceto inject stub file contents afterservices:/volumes:markers, andstr_replacefor path rewriting.After:
Yaml::parseFile()to parse compose file into a PHP array, array manipulation to add/modify services and volumes,Yaml::dump()to write back valid YAML.Key changes:
symfony/yamlas an explicit dependency (^5.4|^6.0|^7.0)InstallCommand: nginx service config defined as a PHP array instead of a stub template; duplicate detection usesisset($dockerCompose['services']['nginx'])instead ofstr_containson raw textPublishCommand: volume path replacement operates on the parsed array instead of raw stringstubs/nginx.stubandstubs/volume.stubErrorExceptiontoSymfony\Component\Yaml\Exception\ParseExceptionto match the newYaml::parseFile()behaviorReview & Testing Checklist for Human
Yaml::dump()output is compatible with docker-compose:Yaml::dump($data, 10, 4)rewrites the entire compose file. Check that quoting/escaping of${...}environment variables (e.g.${HTTP_PORT:-8000}:80,${APP_SERVICE:-laravel.test}) is preserved correctly and doesn't break docker-compose variable interpolation. CI tests verify parsed structure only, not runtime compatibility.sail-ssl:installfollowed bysail-ssl:publishand verify the resulting compose file works withdocker compose up. This is the most important verification sinceYaml::dump()may produce subtly different formatting from the original stubs.stubs/nginx.stuband is now a PHP array inInstallCommand.php. Confirm it matches the intended service configuration.Notes