跳到内容

为 Spark Lance 连接器贡献代码

Spark Lance 连接器的代码库位于 lancedb/lance-spark。

构建命令

此连接器使用 Maven 构建。您可以运行以下 make 命令

# Build all
make build

# Clean all
make clean

# Build Spark 3.5 Scala 2.12
make build-35-212

# Clean build of Spark 3.5 Scala 2.12
make clean-35-212

# Build the runtime bundle of Spark 3.5 Scala 2.12
make bundle-35-212

样式指南

我们使用 checkstyle 和 spotless 来检查代码。

所有 make build 命令都会自动对代码执行 spotless:apply。

要验证样式，请运行

make lint

文档

设置

文档网站使用 mkdocs-material 构建。构建系统需要 uv。

使用以下命令启动服务器

make serve-docs

理解构建过程

lance-spark/docs 中的内容是为了方便贡献者编辑和预览。代码合并后，内容会在 Lance 文档 CI 构建期间添加到 主 Lance 文档，并在 Lance 网站的 Apache Spark 集成 下显示。

CONTRIBUTING.md 文档会自动构建到 Lance 贡献指南

发布流程

本节描述了用于自动化版本管理、发布和发布的 CI/CD 工作流程。

版本方案

  • 稳定版本： X.Y.Z (例如，1.2.3)
  • 预览版本： X.Y.Z-beta.N (例如，1.2.3-beta.1)

创建发布

  1. 创建发布草稿
  2. 转到 Actions → "Create Release"
  3. 选择参数
    • 发布类型 (major/minor/patch)
    • 发布渠道 (stable/preview)
    • 空运行 (不推送地测试)

  4. 运行工作流程 (创建草稿发布)

  5. 审查和发布

  6. 转到发布页面审查草稿
  7. 根据需要编辑发布说明
  8. 点击 "Publish release" 以
    • 对于稳定版本：触发自动 Maven Central 发布
    • 对于预览版本：创建测试版（不发布到 Maven Central）