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

Aperta
#279 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
go
Ambito
api, cli

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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: "."})
Lingua principale
Go
Stelle
317
Fork
24
Merge medio
1g 8h
PR unite (30g)
50

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di github/gh-actions-lock

Tutte le issue di github/gh-actions-lock

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.