AtomCI 快速入门指南

AtomCI 快速入门指南

atomci🐳 为中国企业而来，以应用为中心的云原生cicd平台项目地址:https://gitcode.com/gh_mirrors/at/atomci

本教程将引导您了解并开始使用 AtomCI —— 一个基于 Go 语言构建的持续集成（CI）工具。我们将探讨项目的目录结构、启动文件以及配置文件。

1. 项目目录结构及介绍

AtomCI 的目录结构如下：

atomci/
├── cmd/            # 存放各个命令行接口的源代码
│   └── atomci      # 主入口点
├── internal/       # 内部核心组件
│   ├── app/        # 应用层逻辑
│   ├── dao/        # 数据访问对象
│   ├── model/      # 模型定义
│   ├── service/    # 服务层逻辑
│   └── util/       # 工具函数
├── config/         # 配置文件模板和默认配置
├── Dockerfile      # Docker 容器构建文件
├── go.mod          # Go 依赖管理文件
└── main.go         # 应用主入口

• cmd/atomci: 这是应用的主入口，包含了运行 AtomCI 的命令行脚本。
• internal/: 包含了 AtomCI 的核心业务组件，如应用程序逻辑、数据访问、模型和服务等。
• config/: 提供了配置文件模板，用于设置 AtomCI 的各项参数。
• Dockerfile: 用于构建 Docker 容器镜像的文件，便于在容器环境中部署 AtomCI。
• go.mod: 管理 Go 项目的依赖库，确保正确地安装和更新包。
• main.go: 应用程序的主入口文件，启动时会加载配置并执行相应的初始化工作。

2. 项目启动文件介绍

启动 AtomCI 的主要步骤是从 cmd/atomci/main.go 文件中调用 app.Start() 函数。这个函数会加载配置，创建数据库连接，然后启动监听 HTTP 请求的服务。

首先，确保您已经安装了 Go 语言环境。然后，在项目根目录下，通过以下命令编译并运行 AtomCI：

$ go build ./cmd/atomci
$ ./atomci server

这将在标准输出中显示日志信息，并启动监听默认端口的服务。

3. 项目的配置文件介绍

AtomCI 使用 YAML 格式的配置文件来管理其行为。默认情况下，它会在运行时查找名为 config.yaml 的文件。您可以根据需求修改或替换此文件。

配置文件示例：

server:
  port: 8080
database:
  driver: sqlite3
  source: /path/to/atomci.db
logging:
  level: info
  format: text

• server.port: 设置服务器监听的端口号，默认为 8080。
• database.driver: 数据库存储引擎，目前支持 SQLite3 和其他兼容 Golang 的数据库驱动。
• database.source: 数据库连接字符串，对于 SQLite3，应指向数据库文件路径。
• logging.level: 日志级别，可选值包括 debug, info, warn, error。
• logging.format: 日志格式，可选值为 json 或 text。

为了指定自定义配置文件位置，可以在运行时通过 -c 参数提供：

$ ./atomci server -c /path/to/custom-config.yaml

现在，您已具备了初步使用 AtomCI 的知识，可以继续探索它的更多功能和定制化选项。如有任何疑问，请查阅项目文档或在 GitHub 上向社区提问。

atomci🐳 为中国企业而来，以应用为中心的云原生cicd平台项目地址:https://gitcode.com/gh_mirrors/at/atomci