Expose a public Go library API for `gh-actions-lock`

未关闭
#279 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
35/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
go
领域
api, cli

调研方向

Start by reading the CLI's core implementation under internal/ and trace how it performs locking, relocking, verification, and inspection. Then assess how those operations could be exposed as a typed, context-aware API without requiring gh; done means external Go applications can call the proposed operations through a public package such as pkg/actionslock.

由索引模型根据 Issue 内容生成。

描述

Motivation

gh-actions-lock keeps its core functionality under internal/, forcing external Go applications to invoke the CLI instead of using a type-safe Go API.

Proposal

Expose a public Go package, such as pkg/actionslock, providing typed, context-aware APIs for locking, relocking, verification, and inspection, while reusing the CLI's core implementation without requiring gh.

Usage

Verify a repository directly from Go using an illustrative API:

import "github.com/github/gh-actions-lock/pkg/actionslock"

result, err := actionslock.Verify(ctx, actionslock.Options{RepositoryRoot: "."})
主要语言
Go
星标
317
派生
24
平均合并
1 天 8 小时
30 天内合并 PR
50

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

github/gh-actions-lock 的其他 Issue

查看 github/gh-actions-lock 的全部 Issue

相似的 Issue

更多 Go Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。