unikernel/ocaml-github

ocaml-github: GitHub APIv3 OCaml库

https://img.shields.io/endpoint?url=https://ci.ocamllabs.io/badge/mirage/ocaml-github/master&logo=ocaml]([***] https://img.shields.io/badge/doc-online-blue.svg](https://mirage.github.io/ocaml-github/)

镜像概述

本镜像包含GitHub APIv3的OCaml绑定库及CLI工具，提供JSON格式的API接口，兼容MirageOS，并可通过js_of_ocaml编译为纯JavaScript。库尚未完全覆盖所有API，但已实现部分核心数据类型绑定（见lib/github.atd），包含测试用例和示例工具。

核心功能

1. API绑定：支持OAuth授权（含双因素认证）、事件处理、Gists、Issues、Pull Requests、Repositories等部分API。
2. CLI工具：
   • git jar：管理本地GitHub授权令牌，支持添加、删除、列出令牌。
   • git sync-releases：同步两个仓库间的所有发布。
   • git upload-release：为发布关联二进制文件。
3. 调试支持：通过环境变量输出API调用及HTTP层调试日志。

使用场景

• OCaml开发者与GitHub API交互，实现自动化发布管理、事件监听等任务。
• 在MirageOS或JavaScript环境中调用GitHub API的场景。
• 配合ocaml-github-hooks监听GitHub Webhook事件。

配置说明

调试配置

设置环境变量启用调试：

bash
export GITHUB_DEBUG=1  # 输出API调用日志到stderr
export COHTTP_DEBUG=1  # 输出更详细的HTTP层日志

在OCaml顶层环境中，可设置Github.log_active := true达到GITHUB_DEBUG=1的效果。

git jar使用

管理GitHub授权令牌：

1. 创建令牌：

console
$ git jar make <用户名> <应用名>
Enter Github password: **********
Enter 2FA code from 'app': 123456

2. 查看令牌：

console
$ git jar show <用户名>

3. OCaml代码中使用令牌：

ocaml
# #require "github.unix";;
# Github_cookie_jar.(init () |> Lwt_main.run |> get ~name:"<应用名>");;

发布管理

• 同步发布：

console
$ git sync-releases <源用户> <源仓库> <目标用户> <目标仓库>

• 上传发布文件：

console
$ git upload-release <用户> <仓库> <标签> <文件路径>

Docker部署示例

运行镜像查看git jar帮助：

bash
docker run --rm unikernel/ocaml-github git jar --help

同步发布（需挂载本地令牌目录）：

bash
docker run --rm -v ~/.github/jar:/root/.github/jar unikernel/ocaml-github git sync-releases mirage ocaml-uri avsm ocaml-uri