codecheckers/register

CODECHECK证书注册管理镜像

镜像概述

本镜像用于当register.csv文件通过GitHub Actions更新时，自动渲染CODECHECK证书注册信息，生成多格式的注册表示（包括Markdown表格、JSON数据和HTML页面），支持学术代码检查的注册管理、展示及第三方集成。

核心功能

• 自动渲染：通过GitHub Actions触发，当register.csv更新时自动生成Markdown、JSON和HTML格式的注册内容；
• 多格式输出：提供机器可读（JSON）和人类可读（Markdown、HTML）的输出文件，满足不同场景需求；
• 本地验证：支持使用R命令进行手动渲染和检查，确保注册信息的正确性；
• 归档支持：可将注册数据归档至Zenodo，确保数据的长期保存与引用。

使用场景

• 学术代码检查平台维护CODECHECK证书注册列表；
• 期刊或会议管理代码检查的注册信息（如作为同行评审的一部分）；
• 第三方服务通过JSON接口集成CODECHECK元数据；
• 本地验证注册信息的正确性与完整性。

配置说明

1. 编辑注册信息：修改register.csv文件添加或更新证书条目，包括证书编号、仓库地址、检查类型等；
2. 自动触发：通过GitHub Actions工作流，当register.csv提交后自动执行渲染；
3. 本地手动操作：
   • 渲染注册内容：R -q -e "codecheck::register_render(); warnings()"
   • 检查配置文件：R -q -e "codecheck::register_check(); warnings()"
   • 清除缓存：R -q -e "codecheck::register_clear_cache()"
4. API速率限制处理：设置GITHUB_PAT环境变量（存储于.Renviron文件）以避免GitHub API速率限制。

Docker部署示例

本地手动渲染

将本地目录挂载至镜像，执行渲染命令：

bash
docker run -v $(pwd):/app codecheckers/register R -q -e "codecheck::register_render(); warnings()"

GitHub Actions集成

在工作流中使用镜像自动更新注册内容：

yaml
jobs:
  render-register:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Render register
        uses: docker://codecheckers/register
        with:
          entrypoint: R
          args: -q -e "codecheck::register_render(); warnings()"
      - name: Commit changes
        uses: stefanzweifel/git-auto-commit-action@v5
        with:
          commit_message: Update register representations

许可证

• 数据：Open Data Commons Attribution License（ODC-BY）；
• 代码与文档：https://choosealicense.com/licenses/mit/%E3%80%82

更多信息请访问CODECHECK官网。