schemacrawler/schemacrawler-action

SchemaCrawler Action 镜像文档

镜像概述

SchemaCrawler Action 是一个专为 GitHub Actions 设计的 Docker 镜像，用于在 CI/CD 流程中集成 SchemaCrawler 工具的功能。SchemaCrawler 是一款数据库模式发现和文档生成工具，该 Action 允许开发者在 GitHub 工作流中自动化执行数据库模式爬取、分析及文档生成等任务。

核心功能与特性

• 无缝集成 GitHub Actions：可直接在 GitHub 工作流中配置和运行，无需额外环境配置
• 数据库模式爬取：支持连接多种数据库，获取表结构、视图、存储过程等元数据
• 文档生成：可生成数据库模式的 HTML、Markdown 等格式文档
• 自动化流程：可与其他 CI/CD 步骤结合，实现数据库模式的自动验证、更新与文档同步

使用场景与适用范围

• CI/CD 流程中的数据库模式验证与检查
• 数据库文档的自动化生成与更新
• 数据库版本控制与变更追踪
• 团队协作中的数据库模式共享与同步

使用方法与配置说明

基本使用示例（GitHub Actions Workflow）

在 .github/workflows 目录下创建工作流文件（如 schemacrawler.yml）：

yaml
name: SchemaCrawler Action
on: [push]

jobs:
  schemacrawler:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      
      - name: Run SchemaCrawler Action
        uses: schemacrawler/SchemaCrawler-Action@main
        with:
          # 数据库连接配置
          database-url: "jdbc:postgresql://localhost:5432/mydb"
          database-user: "username"
          database-password: ${{ secrets.DB_PASSWORD }}
          # 输出配置
          output-format: "markdown"
          output-file: "database-schema.md"
          # SchemaCrawler 命令选项
          command: "schema"
          additional-options: "-loglevel=INFO"

配置参数说明

更多信息

详细配置与高级用法请参考 GitHub 仓库：https://github.com/schemacrawler/SchemaCrawler-Action