如何通过ko build将迁移文件加入构建的Go应用容器镜像

我来帮你搞定这个问题！Ko默认只会把编译好的Go二进制包进镜像，要把你的SQL迁移脚本这类静态文件加进去，有几个实用的方法，不管你是把migrations放在子目录还是项目根目录都能用：

方法1：用.ko.yaml配置文件添加额外文件 #

这是最灵活的方式，适合长期维护的项目，通过配置文件统一管理镜像构建规则。

针对你的Option 2（migrations在项目根目录） #

在项目根目录创建或修改.ko.yaml文件，添加如下配置：

builds:
- id: webserver
  dir: ./cmd/webserver
  main: .
  ko:
    extraFiles:
    - source: ./migrations
      destination: /migrations

这个配置会在构建./cmd/webserver的二进制时，把项目根目录下的migrations目录完整复制到镜像里的/migrations路径下。

针对你的Option 1（migrations在cmd/webserver子目录） #

只需要调整extraFiles的source路径即可，或者利用dir已经是./cmd/webserver的相对路径：

builds:
- id: webserver
  dir: ./cmd/webserver
  main: .
  ko:
    extraFiles:
    - source: ./migrations
      destination: /migrations

方法2：用Go embed包嵌入迁移文件（无需修改ko配置） #

如果你不想在镜像里单独维护migrations目录，也可以用Go 1.16+的embed特性把SQL文件直接嵌入到二进制里，然后在应用启动时把文件释放到容器的文件系统中。

比如在你的main.go里添加这段代码：

package main

import (
	"embed"
	"os"
	"path/filepath"
)

//go:embed migrations/*.sql
var migrationsFS embed.FS

func main() {
	// 定义镜像里要存放迁移文件的目标目录
	targetDir := "/migrations"
	// 确保目录存在，不存在就创建
	if err := os.MkdirAll(targetDir, 0755); err != nil {
		panic(err)
	}

	// 遍历嵌入的所有迁移文件，逐个写入到目标目录
	files, err := migrationsFS.ReadDir("migrations")
	if err != nil {
		panic(err)
	}
	for _, f := range files {
		content, err := migrationsFS.ReadFile(filepath.Join("migrations", f.Name()))
		if err != nil {
			panic(err)
		}
		if err := os.WriteFile(filepath.Join(targetDir, f.Name()), content, 0644); err != nil {
			panic(err)
		}
	}

	// 这里继续写你的webserver启动逻辑和迁移执行代码
}

这种方式的好处是，不管你把migrations放在Option 1还是Option 2的位置，只要调整//go:embed的路径就行，完全不用改ko的构建命令或配置。

方法3：直接在ko build命令里加--extra-files参数 #

如果你用的是ko 0.13及以上版本，也可以直接在构建命令里通过--extra-files参数指定要添加的目录，不用写配置文件：

针对Option 2的情况： #

ko build ./cmd/webserver \
  --platform=linux/amd64,linux/arm64,linux/arm/v8 \
  --tags=latest \
  --bare \
  --local \
  --extra-files=./migrations:/migrations

针对Option 1的情况： #

ko build ./cmd/webserver \
  --platform=linux/amd64,linux/arm64,linux/arm/v8 \
  --tags=latest \
  --bare \
  --local \
  --extra-files=./cmd/webserver/migrations:/migrations

这个参数的格式是源路径:镜像内目标路径，非常直观。

注意事项 #

• 如果你用了--bare参数，镜像的默认工作目录是/，所以你在启动脚本里执行迁移工具时，要指定完整路径比如/migrations/xxx.sql。
• 如果你用的是极简基础镜像（比如distroless），要确保镜像支持文件系统写入操作，或者提前在配置里指定合适的基础镜像。

内容来源于stack exchange