italia/publiccode-parser-go

publiccode.yml解析器 (Go语言版)

镜像概述

publiccode.yml是描述公共软件的国际标准，应放置在自由/开源软件（FLOSS）仓库的根目录。本Docker镜像封装了用于解析和验证publiccode.yml文件的Go语言工具，可执行语法和语义验证，完全符合官方规范。

核心功能

• 支持意大利扩展
• 检查ISO 3166-1 alpha-2和alpha-3国家代码
• 验证电子邮件、URL（http协议、有效状态码）、本地及远程文件、"YYYY-MM-DD"格式日期、图像（颜色、MIME类型）
• 检查pa-types（公共行政类型）
• 验证oembed视频链接并检索HTML以便嵌入
• 验证SPDX许可证（不含WITH关键字）
• 检查标签
• 严格和非严格模式（非严格模式适用于爬虫等需容错场景，严格模式适用于编辑器和验证工具）

使用场景

• 公共软件仓库的元数据规范性检查
• 编辑器或IDE中的实时验证工具
• 爬虫系统对公共软件仓库的元数据采集（非严格模式）
• CI/CD流水线中集成公共软件项目的元数据验证

使用方法

Docker验证

通过Docker可在本地机器或CI流水线中轻松验证文件：

基础验证

shell
docker run -i italia/publiccode-parser-go /dev/stdin < publiccode.yml

导出规范化文件

shell
docker run -i italia/publiccode-parser-go -export /dev/stdout /dev/stdin < publiccode.yml

验证本地文件（挂载目录）

假设本地文件路径为/home/my-user/publiccodes/publiccode.yml：

shell
docker run -v /home/my-user/publiccodes:/files italia/publiccode-parser-go

验证指定名称的文件

验证/opt/publiccodes/my-amazing-code.yaml：

shell
docker run -v /opt/publiccodes:/files italia/publiccode-parser-go my-amazing-code.yaml

结合远程仓库验证

对本地文件与远程仓库进行额外验证：

shell
docker run -v /opt/publiccodes:/files italia/publiccode-parser-go -remote-base-url https://raw.githubusercontent.com/USER/REPO/master/

交互式调试

覆盖入口点以进入容器shell：

shell
docker run -it --entrypoint /bin/sh italia/publiccode-parser-go

命令行工具说明

镜像内置pcvalidate命令行工具，返回码说明：

• 0：验证成功
• 1：验证失败

运行帮助命令查看所有标志：

shell
docker run italia/publiccode-parser-go --help

镜像获取

• Docker Hub地址：https://hub.docker.com/repository/docker/italia/publiccode-parser-go
• 本地构建：

shell
git clone https://github.com/italia/publiccode-parser-go.git
cd publiccode-parser-go
docker build -t italia/publiccode-parser-go .

维护者与许可证

• 维护者：由Developers Italia团队维护
• 许可证：欧盟公共许可证（EUPL），版本控制记录包含具体代码行的归属信息

相关项目

• https://github.com/italia/developers-italia-backend%EF%BC%9A%E4%BD%BF%E7%94%A8%E6%AD%A4%E5%BA%93%E7%9A%84Go%E8%AF%AD%E8%A8%80%E7%88%AC%E8%99%AB%E9%A1%B9%E7%9B%AE