orrosenblatt/validate-json-action

GitHub Action：JSON验证镜像

镜像概述

本镜像为GitHub Action工具，用于基于JSON Schema对JSON文件进行合法性验证。它采用高效的JSON schema验证库ajv实现核心功能，可集成到GitHub工作流中，自动检查JSON文件是否符合预设的 schema 规则。

核心功能

1. 支持指定自定义JSON Schema文件路径
2. 批量验证多个JSON文件（以逗号分隔路径）
3. 输出不符合schema的JSON文件路径
4. 与GitHub工作流无缝集成，触发事件（如Pull Request）时自动执行验证

使用场景

• 项目中JSON配置文件的格式检查，确保配置符合规范
• 数据接口JSON响应格式的一致性验证
• 代码提交时自动拦截不符合schema的JSON文件，避免错误合并

配置说明

输入参数（Inputs）

• schema：仓库内JSON Schema文件的相对路径，默认值为./schema.json（必填，若无指定则使用默认路径）
• jsons：仓库内待验证的JSON文件相对路径（多个路径用逗号分隔）

输出参数（Outputs）

• invalid：不符合schema的JSON文件相对路径（多个路径用逗号分隔）

部署示例

以下是在GitHub工作流中使用该镜像的示例（.github/workflows/validate.yml）：

yaml
name: 验证JSON文件
on: [pull_request]

jobs:
  validate-json:
    runs-on: ubuntu-latest
    steps:
      - name: 检出代码
        uses: actions/checkout@v1
      - name: 执行JSON验证
        uses: docker://orrosenblatt/validate-json-action:latest
        env:
          INPUT_SCHEMA: /path/to/your/schema.json
          INPUT_JSONS: /path/to/file1.json,/path/to/file2.json