scala - 如何防止gitlab ci每次都下载sbt？

Question

我们有一个play2/scala使用 gitlab ci 构建的应用程序。

我们的.gitlab-ci.yml（至少是重要的部分）如下所示：

image: hseeberger/scala-sbt

variables:
  SBT_GLOBAL_BASE_DIR: "$CI_PROJECT_DIR/cache/.sbt"
  IVY2_CACHE_DIR: "$CI_PROJECT_DIR/cache/.ivy2"
  SBT_BOOT_DIR:  "$CI_PROJECT_DIR/cache/.sbt/boot"
  M2_HOME_DIR: "$CI_PROJECT_DIR/cache/.m2"

before_script:
  # Log the sbt version
  - sbt sbt-version

build:
  stage: build
  script:
    - ./build.sh

与build.sh：

sbt -Dsbt.global.base=$SBT_GLOBAL_BASE_DIR \
  -Dsbt.ivy.home=$IVY2_CACHE_DIR \
  -Dsbt.boot.directory=$SBT_BOOT_DIR \
  compile

不幸的是，我们的管道在所有步骤（构建、验证、部署）中总是运行大约 30-40 分钟。大部分时间它都花在sbt一遍又一遍地下载真正令人讨厌的东西上。

我可能不太了解，gitlab ci runners但据我了解，通过使用hseeberger/scala-sbt作为图像，sbt应该是全球可用的，应该不需要下载它。

然后也不需要 gitlab 的这个解决方案。

sbt无论如何，如果在每次部署期间服务器运行任何sbt命令时不会完全下载 6 次，我会很高兴。

有人可以解释我如何使用正确image或image正确的方式，或者我如何缓存这些sbt东西吗？

更新

在过去的几天里，我与docker和进行了很多战斗gitlab ci。我发现这个问题与不要下载互联网中描述的几乎相同。拥有所有依赖项似乎是一项艰巨的任务，最好通过挂载它们来完成。不幸的是，这在共享的 gitlab ci 运行器上是不可能的。

我继续发现sbt-docker，它允许您从build.sbt文件构建 docker 容器。使用package basic 方法，我尝试将项目的所有本地可用依赖项作为全局 sbt plugins包含到容器中。但这也无济于事。

maven我最后的发现是关于解决方案的答案，并试图将其转化为我们的sbt项目：

.gitlab-ci.yml

image: hseeberger/scala-sbt

variables:
  MAVEN_OPTS: -Dmaven.repo.local=/cache/maven.repository

stages:
  - build
  - test
  - staging
  - deploy

build:
  stage: build
  script:
    - sbt compile -Dsbt.ivy.home=/cache/.ivy2 -Dsbt.global.base=/cache/.sbt/0.13 -Dsbt.boot.directory=/cache/.sbt/boot -Dsbt.repository.config=/cache/.sbt/repositories

我可以gitlab ci再次访问日志。它们看起来基本上如下：

[info] Loading project definition from /builds/kwiqjobs/backend/project
[info] Updating {file:/builds/kwiqjobs/backend/project/}backend-build...
[info] Resolving com.typesafe.play#sbt-plugin;2.5.4 ...

[info] Resolving com.typesafe.play#sbt-plugin;2.5.4 ...

[info] Resolving com.typesafe.play#sbt-routes-compiler_2.10;2.5.4 ...

[info] Resolving com.typesafe.play#sbt-routes-compiler_2.10;2.5.4 ...

[info] Resolving org.scala-lang#scala-library;2.10.6 ...

[info] Resolving com.typesafe.play#twirl-api_2.10;1.1.1 ...

[info] Resolving com.typesafe.play#twirl-api_2.10;1.1.1 ...

... a **lot** more

[info]  [SUCCESSFUL ] com.typesafe.sbt#sbt-twirl;1.1.1!sbt-twirl.jar (1033ms)
[info] downloading https://repo.scala-sbt.org/scalasbt/sbt-plugin-releases/com.typesafe.sbt/sbt-native-packager/scala_2.10/sbt_0.13/1.0.3/jars/sbt-native-packager.jar ...
[info]  [SUCCESSFUL ] com.typesafe.sbt#sbt-native-packager;1.0.3!sbt-native-packager.jar (954ms)
[info] downloading https://repo.scala-sbt.org/scalasbt/sbt-plugin-releases/com.typesafe.sbt/sbt-web/scala_2.10/sbt_0.13/1.3.0/jars/sbt-web.jar ...
[info]  [SUCCESSFUL ] com.typesafe.sbt#sbt-web;1.3.0!sbt-web.jar (1010ms)
[info] downloading https://repo.scala-sbt.org/scalasbt/sbt-plugin-releases/com.typesafe.sbt/sbt-js-engine/scala_2.10/sbt_0.13/1.1.3/jars/sbt-js-engine.jar ...
[info]  [SUCCESSFUL ] com.typesafe.sbt#sbt-js-engine;1.1.3!sbt-js-engine.jar (1147ms)
[info] downloading https://repo1.maven.org/maven2/com/typesafe/play/twirl-api_2.10/1.1.1/twirl-api_2.10-1.1.1.jar ...
[info]  [SUCCESSFUL ] com.typesafe.play#twirl-api_2.10;1.1.1!twirl-api_2.10.jar (89ms)
[info] downloading https://repo1.maven.org/maven2/commons-io/commons-io/2.4/commons-io-2.4.jar ...
[info]  [SUCCESSFUL ] commons-io#commons-io;2.4!commons-io.jar (48ms)

a **lot** more
[info] Done updating.
[info] Compiling 228 Scala sources and 4 Java sources to /builds/kwiqjobs/backend/target/scala-2.11/classes...
[info] 'compiler-interface' not yet compiled for Scala 2.11.8. Compiling...
[info]   Compilation completed in 17.735 s
[success] Total time: 149 s, completed Jan 20, 2017 2:22:52 PM
Build succeeded

我想摆脱所有的下载。

score 16 · Accepted Answer

如果您不想使用自定义图像，最好的解决方案是使用 Gitlab CI 的缓存机制。

把它做好有点困难，但这篇博文描述了如何为 SBT 做这件事。

例子`.gitlab-ci.yml`

引用自博文，我自己纠正的小错误：

# some parts originally from https://github.com/randm-ch/units-of-information/blob/master/.gitlab-ci.yml

image: "hseeberger/scala-sbt"

variables:
  SBT_VERSION: "0.13.9"
  SBT_OPTS: "-Dsbt.global.base=sbt-cache/.sbtboot -Dsbt.boot.directory=sbt-cache/.boot -Dsbt.ivy.home=sbt-cache/.ivy"

cache:
  key: "$CI_BUILD_REF_NAME" # contains either the branch or the tag, so it's caching per branch
  untracked: true
  paths:
    - "sbt-cache/.ivy/cache"
    - "sbt-cache/.boot"
    - "sbt-cache/.sbtboot"
    - "sbt-cache/target"

stages:
  - test

test:
  script:
    - sbt test

第二个例子，也包括`apt-get`缓存

这是我在项目中使用的，可用于更一般的用例和 Docker 映像：

image: java:8

stages:
  - test

variables:
  SBT_VERSION: "0.13.9"
  SBT_OPTS: "-Dsbt.global.base=sbt-cache/.sbtboot -Dsbt.boot.directory=sbt-cache/.boot -Dsbt.ivy.home=sbt-cache/.ivy"
  SBT_CACHE_DIR: "sbt-cache/.ivy/cache"

cache:
  key: "$CI_BUILD_REF_NAME" # contains either the branch or the tag, so it's caching per branch
  untracked: true
  paths:
    - "apt-cache/"
    - "sbt-cache/.ivy/cache"
    - "sbt-cache/.boot"
    - "sbt-cache/.sbtboot"
    - "sbt-cache/target"

before_script:
  - export APT_CACHE_DIR=`pwd`/apt-cache
  - mkdir -pv $APT_CACHE_DIR
  - ls $APT_CACHE_DIR || echo "no apt-cache dir found"
  - apt-get -o dir::cache::archives=$APT_CACHE_DIR update -y
  - apt-get -o dir::cache::archives=$APT_CACHE_DIR install apt-transport-https -y
  # Install SBT
  - mkdir -pv $SBT_CACHE_DIR
  - ls $SBT_CACHE_DIR || echo "no ivy2 cache fir found"
  - echo "deb http://dl.bintray.com/sbt/debian /" | tee -a /etc/apt/sources.list.d/sbt.list
  - apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 642AC823
  - apt-get -o dir::cache::archives=$APT_CACHE_DIR update -y
  - apt-get -o dir::cache::archives=$APT_CACHE_DIR install sbt -y
  - sbt -v sbtVersion

test:
  stage: test
  script:
     - sbt -v sbtVersion

score 2 · Accepted Answer

您可以做 4 件事：

自己的 docker 镜像
缓存
人工制品
使用自己的缓存解决方案

最好的解决方案是混合使用它们。

您可以使用所需的所有依赖项构建自己的 docker 映像，这是最快的解决方案，因为它不必下载所有内容，但它会引入您需要处理的另一块难题。您可以使用内置的 gitlab 存储库来存储它，并让 gitlab 构建它然后使用它。
您可以在 Gitlab CI 作业中使用缓存，这样就不必一直下载所有内容。sbt 的默认缓存似乎是 ~/.ivy2 所以添加

cache:
  paths:
    - ~/.ivy2/

作为 gitlab 文件中的第一行，为每个阶段使用缓存。

将目标目录定义为工件以在构建之间传递它，因此您不必在每个阶段都构建它。

artifacts:
  paths:
    - target/

如果 gitlab 提供的选项不够用，你可以将需要缓存的文件存储在自己的 s3/minio/nfs 中。这将是一个非常定制的解决方案，因此您必须找到自己的解决方案。

scala - 如何防止gitlab ci每次都下载sbt？

更新

.gitlab-ci.yml

2 回答 2

例子.gitlab-ci.yml

第二个例子，也包括apt-get缓存

Related

Reference

例子`.gitlab-ci.yml`

第二个例子，也包括`apt-get`缓存