Earthly项目教程：深入理解构建输出机制

Earthly项目教程：深入理解构建输出机制

earthly Super simple build framework with fast, repeatable builds and an instantly familiar syntax – like Dockerfile and Makefile had a baby. 项目地址: https://gitcode.com/gh_mirrors/ea/earthly

前言

在持续集成和持续部署(CI/CD)流程中，构建工具的输出管理是一个关键环节。Earthly作为一款现代化的构建工具，提供了灵活而强大的输出机制。本文将深入探讨Earthly中的各种输出方式，帮助开发者更好地控制构建产物的流向。

Earthly构建输出的基本概念

Earthly构建过程中的输出主要分为两类：内部传递和外部输出。理解这一区别对于设计高效的构建流程至关重要。

内部传递机制

在Earthly中，SAVE ARTIFACT命令用于在构建目标(target)之间传递文件或目录。这种传递发生在Earthly的构建环境内部，不会影响本地文件系统。

build:
    COPY main.go .
    RUN go build -o output/example main.go
    SAVE ARTIFACT output/example

在这个例子中，构建生成的二进制文件被保存为artifact，可供其他目标使用，但不会自动保存到本地机器。

外部输出机制

要将构建产物输出到本地文件系统，需要在SAVE ARTIFACT命令中添加AS LOCAL参数：

build:
    COPY main.go .
    RUN go build -o output/example main.go
    SAVE ARTIFACT output/example AS LOCAL local-output/go-example

执行earthly +build后，构建产物将被保存到本地local-output/go-example路径。

Docker镜像的输出管理

Earthly对Docker镜像的输出提供了直观的支持：

docker:
    COPY +build/example .
    ENTRYPOINT ["/go-workdir/example"]
    SAVE IMAGE go-example:latest

执行earthly +docker后，Docker镜像将保存在本地镜像仓库中，可以通过docker image ls或podman image ls查看。

输出行为的精细控制

Earthly的一个强大特性是它对输出行为的精细控制。当目标被其他目标通过FROM或COPY引用时，默认不会产生外部输出。这种设计避免了构建过程中的副作用，确保了构建的可预测性。

如果需要在这种引用情况下仍然产生输出，可以使用BUILD命令：

docker:
    BUILD +build
    COPY +build/example .
    ENTRYPOINT ["/go-workdir/example"]
    SAVE IMAGE go-example:latest

远程推送功能

Earthly不仅支持本地输出，还支持将构建产物推送到远程仓库。

镜像推送

通过添加--push标志，可以将镜像推送到远程仓库：

docker:
    COPY +build/example .
    ENTRYPOINT ["/go-workdir/example"]
    SAVE IMAGE --push go-example:latest

执行时需要同时使用--push参数：earthly --push +docker

外部变更操作

--push标志还可用于执行影响外部环境的命令，如数据库迁移、Terraform应用等：

migrate:
    FROM +build
    RUN --push bundle exec rails db:migrate

这种设计确保只有在整个构建成功时才会执行这些关键操作。

多语言示例解析

Earthly的输出机制适用于各种编程语言环境，下面简要分析几种常见语言的实现方式。

JavaScript项目

JavaScript项目通常不需要编译步骤，可以直接将源代码作为artifact：

build:
    COPY src/index.js .
    SAVE ARTIFACT index.js /dist/index.js AS LOCAL ./dist/index.js

Java项目

Java项目通常需要构建步骤，输出包含编译后的class文件和依赖：

build:
    RUN gradle build
    RUN gradle install
    SAVE ARTIFACT build/install/java-example/bin /bin AS LOCAL build/bin
    SAVE ARTIFACT build/install/java-example/lib /lib AS LOCAL build/lib

Python项目

与JavaScript类似，Python项目通常直接使用源代码：

build:
    COPY src src
    SAVE ARTIFACT src /src

最佳实践建议

1. 明确区分内部传递和外部输出：只在必要时使用AS LOCAL输出到本地
2. 谨慎使用推送操作：确保--push操作是必要且安全的
3. 保持构建的幂等性：设计构建流程时应考虑可重复执行
4. 合理组织输出目录：为本地输出创建清晰的目录结构

结语

Earthly的输出机制提供了从简单文件保存到复杂部署流程的全面支持。通过合理利用这些功能，开发者可以构建出既高效又可靠的CI/CD流程。理解这些输出行为的细节，将帮助您更好地控制构建产物的流向，实现更精细的构建管理。

earthly Super simple build framework with fast, repeatable builds and an instantly familiar syntax – like Dockerfile and Makefile had a baby. 项目地址: https://gitcode.com/gh_mirrors/ea/earthly