如何用sed向docker-compose.yml插入新服务？bash脚本报错解决

问题 #

我想通过bash脚本向docker-compose.yml中添加新服务，写了如下脚本：

#!/bin/bash

# 检查文件是否存在
if [ ! -f "docker-compose.yml" ]; then
  echo "Error: docker-compose.yml file not found"
  exit 1
fi

# 向docker-compose.yml插入新服务
new_service=$(cat << SERVICE
# New service section
new_service:
  image: some_image
  ports:
    - "8080:80"
SERVICE
)

# 检查服务是否已存在
if grep -q "^new_service:" docker-compose.yml; then
  echo "Service 'new_service' exists in docker-compose.yml"
else
  echo "Service 'new_service' does not exist in docker-compose.yml, inserting"
  sed -i "/# New service section/a ${new_service}" docker-compose.yml
  echo "Service section added to docker-compose.yml"
fi

执行时抛出错误：

Service 'new_service' does not exist in docker-compose.yml, inserting
sed: -e expression #1, char 49: extra characters after command
Service section added to docker-compose.yml

使用的基础docker-compose.yml内容如下：

version: "3.9"
services:
  redis:
    image: "redis:alpine"
# New service section

请问有没有更优的实现方法？

问题原因与解决方法 #

1. sed报错的核心原因 #

sed的a命令仅支持单行内容追加，而你定义的new_service包含换行符，直接展开后会被sed当成多个命令的分隔符，导致语法解析失败。

2. 修正后的sed版本脚本 #

可以通过从标准输入读取多行内容的方式实现追加，避免换行符的干扰：

#!/bin/bash

# 检查文件是否存在
if [ ! -f "docker-compose.yml" ]; then
  echo "Error: docker-compose.yml file not found"
  exit 1
fi

# 定义新服务（原文件已有注释，此处不再重复）
new_service=$(cat << SERVICE
new_service:
  image: some_image
  ports:
    - "8080:80"
SERVICE
)

# 检查服务是否已存在
if grep -q "^new_service:" docker-compose.yml; then
  echo "Service 'new_service' exists in docker-compose.yml"
else
  echo "Service 'new_service' does not exist in docker-compose.yml, inserting"
  # 通过标准输入传递多行内容，追加到匹配行后
  printf "%s\n" "$new_service" | sed -i '/# New service section/r /dev/stdin' docker-compose.yml
  echo "Service section added to docker-compose.yml"
fi

3. 更优实现：用yq操作结构化YAML #

sed是文本处理工具，对YAML这种结构化格式的操作容易受空格、注释位置等因素影响。使用专门的YAML工具yq（v4版本）能更可靠地操作配置：

#!/bin/bash

# 检查文件是否存在
if [ ! -f "docker-compose.yml" ]; then
  echo "Error: docker-compose.yml file not found"
  exit 1
fi

# 检查服务是否已存在
if yq eval '.services | has("new_service")' docker-compose.yml | grep -q true; then
  echo "Service 'new_service' exists in docker-compose.yml"
else
  echo "Service 'new_service' does not exist in docker-compose.yml, inserting"
  # 直接向services节点添加结构化的新服务
  yq eval '.services.new_service = {"image": "some_image", "ports": ["8080:80"]}' -i docker-compose.yml
  echo "Service section added to docker-compose.yml"
fi

这种方法直接操作YAML的层级结构，无需依赖注释位置，兼容性和鲁棒性更强。

内容的提问来源于stack exchange，提问作者perler