Help us shape the future of Go! Take the 2026 Go Developer Survey

github

package
v1.4.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 6, 2026 License: MIT Imports: 17 Imported by: 0

Documentation

Overview

Package github opens digest-pin Proposals as pull requests. It never merges, never deploys, and never force-pushes: it writes one file on one branch and opens one pull request, idempotently, so a run that repeats finds the Proposal it already made instead of making another.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Adapter 

type Adapter struct {
	// contains filtered or unexported fields
}

Adapter opens Proposals against one repository.

func New 

func New(options Options) (*Adapter, error)

New builds an Adapter, reading and validating the token file.

func (*Adapter) BranchExists added in v1.4.1 

func (a *Adapter) BranchExists(label string) (bool, error)

BranchExists reports whether any Proposal branch for the label is on the forge, whatever digest it pins.

func (*Adapter) Propose 

func (a *Adapter) Propose(change proposal.Change) (proposal.Result, error)

Propose opens (or finds) the digest-pin pull request for one change.

type HTTPError 

type HTTPError struct {
	Status int
	Detail string
}

HTTPError is a non-2xx GitHub API response.

func (*HTTPError) Error 

func (e *HTTPError) Error() string

type Options 

type Options struct {
	Repository string
	BaseBranch string
	TokenFile  string
	Timeout    time.Duration
	BaseURL    string
	HTTPClient *http.Client
}

Options configures an Adapter.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.