-
Notifications
You must be signed in to change notification settings - Fork 19.9k
fix(docker): define YAML anchor as empty map for docker compose config #30578
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix(docker): define YAML anchor as empty map for docker compose config #30578
Conversation
The x-shared-env anchor was defined without a value, causing
docker compose config to fail with "yaml: map merge requires
map or sequence of maps as the value" error.
This fix defines the anchor as an empty map `{}` to allow proper
YAML merging in the environment sections of api and worker services.
Fixes langgenius#30247
Signed-off-by: majiayu000 <1835304752@qq.com>
Summary of ChangesHello @majiayu000, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request resolves a critical configuration issue within the Docker setup by fixing an improperly defined YAML anchor. The Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
Summary of ChangesHello @majiayu000, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request addresses a critical syntax error in the Docker Compose configuration that prevented Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request correctly fixes a YAML syntax error in docker-compose-template.yaml by defining the x-shared-env anchor as an empty map. This makes the template file valid and parsable on its own. However, this change introduces a side effect that breaks the docker/generate_docker_compose script, which relies on a specific regex to process this template. The script will fail to remove the old anchor, resulting in a malformed docker-compose.yaml file. I've provided a specific comment on how to resolve this issue in the script.
| @@ -1,4 +1,4 @@ | |||
| x-shared-env: &shared-api-worker-env | |||
| x-shared-env: &shared-api-worker-env {} | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While this change correctly makes the YAML file valid, it inadvertently breaks the docker/generate_docker_compose script. The script's regular expression at line 63, r"^x-shared-env: &shared-api-worker-env\s*\n?", no longer matches this updated line.
This will cause the script to fail to remove this line, leading to a docker-compose.yaml with a duplicate x-shared-env key, which is invalid.
To fix this, you should update the regex in docker/generate_docker_compose to accommodate this change. Here is a suggested fix:
# In docker/generate_docker_compose at line 62
template_content = re.sub(
r"^x-shared-env: &shared-api-worker-env.*\n?",
"",
template_content,
flags=re.MULTILINE,
)After applying this change to the script, please remember to regenerate the docker-compose.yaml file and include it in this pull request.
Summary
docker compose configto failx-shared-envanchor was defined without a value, now defined as empty map{}Fixes #30247
Screenshots
yaml: map merge requires map or sequence of maps as the valueChecklist
dev/reformat(backend) andcd web && npx lint-staged(frontend) to appease the lint gods