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

オープン
#279 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
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時間
マージ済み PR(30日)
50

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

github/gh-actions-lock のほかの issue

github/gh-actions-lock の issue をすべて見る

似ている issue

Go の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。