Travis Build 使用与技术文档

1. 安装指南

Travis Build 是一个提供 API 的项目，用于生成可在作业执行环境中运行的 bash 脚本。以下是安装步骤：

• 克隆项目仓库：

  git clone https://github.com/travis-ci/travis-build
  

• 进入项目目录：

  cd travis-build
  

• 创建符号链接到 .travis 目录：

  mkdir -p ~/.travis
  ln -s $PWD ~/.travis/travis-build
  

• 安装 Bundler 并在符号链接的目录下安装依赖：

  gem install bundler
  bundle install --gemfile ~/.travis/travis-build/Gemfile
  

• 生成 Bundler 的 bin stubs：

  bundler binstubs travis
  

2. 项目使用说明

安装完成后，可以使用 Travis Build 作为 Travis CLI 的插件，或者通过 standalone CLI 脚本使用。

使用为 Travis CLI 插件

运行以下命令，生成 bash 脚本：

~/.travis/travis-build/bin/travis compile

生成的脚本可能包含对系统的修改，因此建议在容器或虚拟环境中运行。

调用方式

• 无参数：生成并打印本地 .travis.yml 中的 bash 脚本，不考虑 env 和 matrix 值。

  ~/.travis/travis-build/bin/travis compile
  

• 单个整数参数：为给定构建生成脚本（或构建矩阵的第一个作业）。

  ~/.travis/travis-build/bin/travis compile 8
  

• M.N 形式的参数：为特定作业生成 bash 脚本。

  ~/.travis/travis-build/bin/travis compile 351.2
  

生成的脚本可以在与 Travis CI 构建环境相似的容器或虚拟环境中使用，以帮助调试构建失败。

3. 项目 API 使用文档

Travis Build 的 API 可以通过以下方式调用：

bundle exec script/compile < payload.json > build.sh

这里 payload.json 是一个 JSON 格式的有效载荷文件，build.sh 是生成的 bash 脚本。

4. 项目安装方式

除了上述的安装步骤，您还可以使用 Docker 容器在本地机器上运行 Travis Build。

使用 Docker 容器

1. 构建镜像：

   docker-compose build web
   

2. 运行镜像：

   docker-compose run web
   

如果需要本地开发环境，可以使用以下命令：

docker-compose run -e RACK_ENV=development -p 4000:4000 web

这将创建一个包含 travis-build 仓库内容的容器，并在该目录下启动。

以上即是 Travis Build 的安装指南、使用说明和项目 API 使用文档。希望对您的使用有所帮助。