fthomas/scala-steward

Scala Steward Docker镜像文档

镜像概述

Scala Steward Docker镜像封装了Scala Steward工具（详见官方网站），提供了一种便捷的方式在容器环境中运行依赖更新服务。该工具通过自动检测依赖更新、生成更新PR等功能，简化Scala项目的依赖管理流程。

核心功能与特性

• 自动依赖更新：自动检测项目中过时的依赖项，并识别可用更新版本。
• 多构建工具支持：兼容sbt、Maven、Gradle等主流Scala构建工具。
• PR生成能力：可直接向代码仓库（如GitHub、GitLab）提交更新PR，包含详细的更新说明。
• 配置灵活性：支持自定义更新策略（如忽略特定依赖、设置更新频率等）。
• 轻量级部署：通过Docker容器化部署，简化环境配置，支持跨平台运行。

使用场景与适用范围

• Scala项目依赖管理：适用于使用sbt、Maven或Gradle构建的Scala项目。
• 个人/团队开发流程：帮助个人开发者或团队自动维护依赖，减少手动检查和更新的时间成本。
• 持续集成/持续部署（CI/CD）：可集成到CI/CD流程中，定期执行依赖更新检查。

使用方法和配置说明

基本使用流程

1. 准备代码仓库访问凭证（如GitHub Personal Access Token，需包含repo权限）。
2. 配置目标仓库信息（如仓库所有者、仓库名）。
3. 通过Docker命令运行Scala Steward容器，指定必要参数。

Docker运行示例

bash
docker run -it --rm \
  -e GITHUB_API_URL=https://api.github.com \
  -e GITHUB_ACCESS_TOKEN=<your-github-token> \
  -e REPOSITORY=<owner>/<repo-name> \
  scala-steward/scala-steward:latest

核心配置参数（环境变量）

高级配置

如需自定义更新策略，可通过挂载配置文件实现。例如，创建steward.conf配置文件：

hocon
updateRules = [
  {
    dependency = "org.scala-lang:scala-library"
    updatePolicy = "latest.patch"
  }
]

运行容器时挂载配置文件：

bash
docker run -it --rm \
  -e GITHUB_ACCESS_TOKEN=<your-github-token> \
  -e REPOSITORY=<owner>/<repo-name> \
  -v $(pwd)/steward.conf:/app/steward.conf \
  scala-steward/scala-steward:latest --config /app/steward.conf

注意事项

• 确保访问令牌权限充足，避免因权限不足导致PR提交失败。
• 首次运行时可能需要较长时间，具体取决于项目依赖数量和仓库大小。
• 可通过添加--dry-run参数进行试运行，验证配置是否正确而不实际提交PR。