github

package module
v0.12.1 Latest Latest
Warning

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

 Go to latest Published: Aug 19, 2026 License: MIT Imports: 15 Imported by: 0

README

forge-github

GitHub provider for forge — releases, device-flow login and SSH-key upload

Go Reference Pipeline Coverage phpboyscout Go toolkit

Part of the phpboyscout Go toolkit. Full documentation lives on the core module's site: forge.go.phpboyscout.uk

Implements the forge.Provider release contract for GitHub, using go-github, plus the optional Authenticator (OAuth device-flow login) and KeyManager (SSH-key upload) capabilities. Works against github.com and GitHub Enterprise.

Capabilities

Releases, plus the optional forge.Authenticator (OAuth device flow), forge.KeyManager, forge.Repositories, forge.Contents, forge.Sites, forge.Issues, forge.IssueFiler and forge.Snippets.

The authoritative, cross-provider list is the capability matrix in the core documentation — it is kept there rather than here so one table describes every adapter, instead of five that drift apart.

A caller type-asserts for a capability and, on a miss (or forge.ErrNotSupported), falls back — e.g. manual token entry when no client ID is configured. Presentation stays in the CLI: this adapter speaks only the OAuth protocol and surfaces the device code; the Prompter decides whether to open a browser.

Use it

import (
    "gitlab.com/phpboyscout/go/forge"

    _ "gitlab.com/phpboyscout/go/forge-github"
)

factory, err := forge.Lookup("github")
provider, err := factory(ctx, ep, cfg)

go get gitlab.com/phpboyscout/go/forge-github

Configuration

Key Purpose
github.auth.value The token, read through forge.ConfigCredential
github.auth.client_id OAuth app client ID for device-flow login (else GITHUB_CLIENT_ID)
github.url.api Override the API endpoint
github.url.upload Override the asset-upload endpoint
GITHUB_TOKEN Well-known fallback

[!IMPORTANT] github.auth.env and github.auth.keychain are no longer read. Ordering now belongs to your config stack rather than to a ladder inside this module: an environment reference becomes an env layer (or forge.EnvCredential), and a keychain reference becomes a config-keychain layer. Configuration still carrying either key reports forge.ErrStaleAuthKeys, but only when nothing else supplied a credential — so a stale key beside a working variable stays quiet. See the migration table in forge's README.

For GitHub Enterprise, set Endpoint.Host and the API and upload endpoints are derived (/api/v3/ and /api/uploads/). Setting url.api alone still derives a matching upload endpoint, so assets never target the wrong host.

A token is optional — public repositories resolve unauthenticated.

Documentation

Guides, the provider contract, and how to author your own: forge.go.phpboyscout.uk.

API reference: pkg.go.dev.

License

See LICENSE.

Documentation

Overview

Package github implements a forge.Provider for GitHub repositories, for both public and token-authenticated access. Alongside the release contract it implements the optional Authenticator, KeyManager, Repositories, Contents, Sites, Issues, IssueFiler and Snippets capabilities.

Provider construction uses package-owned Settings; config integration lives in SettingsFromConfig, and NewProviderFromClient takes a go-github client the caller already holds.

GitHub's wider API — pull requests, repository creation — is deliberately not here. It is parked in the forge module's provider-contract-widening spec, to be added across every provider in lockstep when a concrete consumer needs it, rather than letting one forge acquire capabilities the others lack.

Index

Constants

View Source 
const DefaultClientIDEnv = "GITHUB_CLIENT_ID"

DefaultClientIDEnv is the well-known environment variable consulted for the OAuth app client ID that the interactive device-flow login ([Authenticator]) requires, when Settings.ClientID is empty.

View Source 
const DefaultTokenEnv = "GITHUB_TOKEN"

DefaultTokenEnv is the well-known environment variable the default credential composition consults last. See SettingsFromConfig.

This is the one rung of the old resolution chain that layer composition cannot express — an unprefixed, forge-chosen name — and it is what CI injects, so it survives as a composed default rather than a hardcoded tier.

The suppression below is a false positive that cannot be designed away: gosec G101 matches the literal "GITHUB_TOKEN" against its list of known credential patterns, but this is the NAME of an environment variable, not a secret — and it is the name GitHub's own tooling uses, so it cannot be spelled differently. Renaming the constant does not help; gosec keys on the value. The sibling providers escape only because "GITEA_TOKEN" and "DIRECT_TOKEN" are not on that list.

Variables

View Source 
var ErrCredentialWithClient = errors.NewSentinel("forge_github.credential_with_client",
	"a credential was supplied alongside an injected client; the client carries its own")

ErrCredentialWithClient reports a credential supplied alongside an injected client.

It is an error rather than a silently ignored field because the two answers a caller might expect are both wrong. Ignoring it would let someone believe their credential is in play when the client's is; layering it would mean two credentials on one connection, with no way to say which the forge saw.

View Source 
var ErrEndpointWithClient = errors.NewSentinel("forge_github.endpoint_with_client",
	"an API or upload URL was supplied alongside an injected client; the client already has its own")

ErrEndpointWithClient reports an API or upload URL supplied alongside an injected client.

Those fields configure the client this module would otherwise build. Alongside one that already exists they are read by nothing, so a caller setting them is addressing an instance the provider will never contact.

Functions

func NewProviderFromClient added in v0.12.0 

func NewProviderFromClient(
	_ context.Context, client *github.Client, settings Settings,
) (forge.Provider, error)

NewProviderFromClient builds a provider on a go-github client the caller already has — rung 1 of the ladder in spec 0008 D10.

This rung transfers the credential obligation

The client carries its own authentication, and this provider adds none. That is the whole point of the rung: a caller reaching for it has authentication go-github can express and this module cannot — a GitHub App installation transport, a rotating token source, an enterprise proxy.

Settings.Credential must therefore be nil, and supplying one is ErrCredentialWithClient rather than a silent preference.

Asset downloads keep working. go-github makes the authenticated hop to the API with this client, stops at the redirect, and follows it with a credential-free client this adapter builds — so a private asset resolves through the caller's authentication without that authentication reaching the author-controlled storage host.

Settings still carries the non-connection concerns: the logger, the OAuth client ID for [Authenticator], and [Endpoint.Host], which governs the OAuth host the device-flow login uses — set it for an Enterprise instance.

Settings.APIURL and Settings.UploadURL must be empty. They configure the client this module would otherwise BUILD, so alongside an injected one they are read by nothing: the endpoints are already fixed in the client. Rejecting them is the same call as rejecting a credential — a field that silently does nothing is worse than one that refuses.

func NewReleaseProvider 

func NewReleaseProvider(ctx context.Context, settings Settings) (forge.Provider, error)

NewReleaseProvider builds a GitHub release provider from explicit typed settings, constructing its own API client.

The credential comes from Settings.Credential, or — when that is nil — from DefaultTokenEnv. The context bounds its resolution: a source the caller supplied may reach a keychain or a remote secret store.

Types

type GitHubReleaseProvider 

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

GitHubReleaseProvider implements forge.Provider.

func (*GitHubReleaseProvider) CreateIssue added in v0.4.0 

func (p *GitHubReleaseProvider) CreateIssue(
	ctx context.Context, owner, repo string, draft forge.IssueDraft,
) (forge.Issue, error)

CreateIssue files an issue.

Labels are names here, so unlike the Gitea adapter there is nothing to resolve.

func (*GitHubReleaseProvider) CreateSnippet added in v0.8.0 

func (p *GitHubReleaseProvider) CreateSnippet(
	ctx context.Context, scope forge.SnippetScope, opts forge.SnippetCreateOptions,
) (forge.Snippet, error)

CreateSnippet creates a gist.

func (*GitHubReleaseProvider) DeleteSnippet added in v0.8.0 

func (p *GitHubReleaseProvider) DeleteSnippet(
	ctx context.Context, scope forge.SnippetScope, id string,
) error

DeleteSnippet removes a gist by its opaque ID.

func (*GitHubReleaseProvider) DownloadReleaseAsset 

func (p *GitHubReleaseProvider) DownloadReleaseAsset(ctx context.Context, owner, repo string, asset forge.ReleaseAsset) (io.ReadCloser, string, error)

func (*GitHubReleaseProvider) GetFile added in v0.3.0 

func (p *GitHubReleaseProvider) GetFile(
	ctx context.Context, owner, repo, path, ref string, maxBytes int64,
) ([]byte, error)

GetFile reads one file at a ref without cloning.

GitHub is the one provider that can enforce maxBytes PROPERLY: DownloadContents hands back an io.ReadCloser, so the bound is applied to the stream and a hostile or merely enormous file is cut off mid-flight. GitLab and Gitea have to pre-check a reported size instead, because their SDKs buffer the whole body before returning it — a weaker guarantee the contract permits but does not prefer.

The limit is read with one extra byte of headroom so exceeding it is detectable rather than silently truncating at exactly maxBytes.

func (*GitHubReleaseProvider) GetIssue added in v0.4.0 

func (p *GitHubReleaseProvider) GetIssue(
	ctx context.Context, owner, repo string, number int,
) (forge.Issue, error)

GetIssue returns one issue by its per-repository number.

func (*GitHubReleaseProvider) GetLatestRelease 

func (p *GitHubReleaseProvider) GetLatestRelease(ctx context.Context, owner, repo string) (forge.Release, error)

func (*GitHubReleaseProvider) GetReleaseByTag 

func (p *GitHubReleaseProvider) GetReleaseByTag(ctx context.Context, owner, repo, tag string) (forge.Release, error)

func (*GitHubReleaseProvider) GetSite added in v0.3.0 

func (p *GitHubReleaseProvider) GetSite(
	ctx context.Context, owner, repo string,
) (forge.Site, error)

GetSite reports a repository's GitHub Pages site.

Reading Pages settings needs the repo scope, so a refusal is routine for a read-only caller — and it is deliberately NOT folded into ErrNotFound. Telling a caller "this repository has no site" when the truth is "your token could not ask" is how a qualifying repository silently drops out of a corpus.

func (*GitHubReleaseProvider) GetSnippet added in v0.8.0 

func (p *GitHubReleaseProvider) GetSnippet(
	ctx context.Context, scope forge.SnippetScope, id string,
) (forge.Snippet, error)

GetSnippet returns one gist by its opaque ID, with file contents.

func (*GitHubReleaseProvider) ListComments added in v0.4.0 

func (p *GitHubReleaseProvider) ListComments(
	ctx context.Context,
	owner, repo string,
	number int,
	q forge.CommentQuery,
	yield func(forge.Comment) bool,
) error

ListComments yields an issue's comments.

GitHub takes Since server-side, so there is no emulation here — and it returns oldest-first, the opposite of the GitLab adapter's emulated newest-first. The contract promises no ordering precisely because those two disagree.

func (*GitHubReleaseProvider) ListReleases 

func (p *GitHubReleaseProvider) ListReleases(ctx context.Context, owner, repo string, limit int) ([]forge.Release, error)

ListReleases returns up to limit releases, paginating across GitHub's pages until the limit is met or history is exhausted. A limit <= 0 means "no explicit bound" — the natural first page. See forge.Provider.

func (*GitHubReleaseProvider) ListRepositories added in v0.3.0 

func (p *GitHubReleaseProvider) ListRepositories(
	ctx context.Context,
	namespace string,
	opts forge.RepositoryListOptions,
	yield func(forge.Repository) bool,
) error

ListRepositories enumerates the repositories owned by a namespace.

GitHub reads organisations and users through different endpoints and a login does not say which it is, so the kind is RESOLVED before enumeration begins: GET /users/{name} reports "User" or "Organization" authoritatively, in one request.

The shortcut this deliberately avoids — call the org endpoint, fall back to the user endpoint on 404 — fails OPEN. GitHub answers 404 rather than 403 for an organisation the token cannot see, so as not to leak its existence, and /users/{login}/repos then SUCCEEDS for that same organisation returning its PUBLIC repositories only. The caller would receive a short list indistinguishable from a complete one, which for a corpus defined by a predicate is silent truncation rather than an error.

func (*GitHubReleaseProvider) ListSnippets added in v0.8.0 

func (p *GitHubReleaseProvider) ListSnippets(
	ctx context.Context, scope forge.SnippetScope,
) ([]forge.Snippet, error)

ListSnippets returns the account's gists.

func (*GitHubReleaseProvider) Login added in v0.2.0 

func (p *GitHubReleaseProvider) Login(ctx context.Context, prompter forge.Prompter) (string, error)

Login implements the optional forge.Authenticator capability via GitHub's OAuth device flow (RFC 8628): it requests a device code, surfaces it through the forge.Prompter for the user to enter in a browser, then polls for the access token. Presentation — including whether to open a browser at the verification URL — belongs to the Prompter; this adapter speaks only the protocol.

It returns an error wrapping forge.ErrNotSupported when no OAuth client ID is configured (Settings.ClientID or DefaultClientIDEnv), so the caller falls back to manual token entry.

func (*GitHubReleaseProvider) SearchIssues added in v0.4.0 

func (p *GitHubReleaseProvider) SearchIssues(
	ctx context.Context,
	owner, repo string,
	q forge.IssueQuery,
	yield func(forge.Issue) bool,
) error

SearchIssues yields issues matching q.

The endpoint is chosen by whether q.Text is set, because only one of the two can honour it. Both paths filter out pull requests: GitHub returns them from the issue endpoints, and a caller looking for a duplicate support question must not be handed a pull request and told it already asked.

func (*GitHubReleaseProvider) UploadKey added in v0.2.0 

func (p *GitHubReleaseProvider) UploadKey(ctx context.Context, name string, publicKey []byte) error

UploadKey implements the optional forge.KeyManager capability: it registers an OpenSSH-format public key on the authenticated account via GitHub's user-keys API. The provider's resolved token (see Settings.Credential) authorises the call; name is the label shown in the account's key list.

type Settings 

type Settings struct {
	// Endpoint addresses this instance. Type is [forge.SourceTypeGitHub]; Host
	// selects the GitHub Enterprise instance, empty meaning github.com; Name
	// selects which configured source this is and scopes the configuration
	// subtree read by [SettingsFromConfig].
	Endpoint forge.Endpoint

	// APIURL overrides the API endpoint. Empty derives it from
	// Endpoint.Host, or uses github.com.
	APIURL string `json:"api_url" yaml:"api_url"`

	// UploadURL overrides the asset-upload endpoint. Empty derives it from
	// APIURL.
	UploadURL string `json:"upload_url" yaml:"upload_url"`

	// Credential yields the token this provider authenticates with.
	//
	// Nil is not an error: the client falls back to [DefaultTokenEnv], so
	// construction from configuration alone keeps working and a public
	// repository needs nothing at all. Set it to take over entirely —
	// including to hand in a token directly:
	//
	//	Credential: forge.StaticCredential(token)
	Credential forge.CredentialSource

	// Logger receives this provider's diagnostics. Nil discards them, and is
	// never [slog.Default]. See [forge.WithLogger] for the registry route.
	Logger *slog.Logger

	// HTTPTransport is the transport this provider builds its clients on, so
	// several providers share one connection pool and TLS session cache. Nil
	// means it builds its own, which is the default and always valid.
	//
	// This provider still builds the client, and so keeps its own redirect and
	// sensitive-header policy. It is the rung to prefer. Set through the
	// registry with [forge.WithHTTPTransport].
	HTTPTransport http.RoundTripper

	// HTTPClient replaces the client this provider would have built for its own
	// API requests — redirect policy included, and the obligation with it.
	//
	// It is NOT used as the credential-free redirect follower for an asset
	// download; see connection.go for why. Set through the registry with
	// [forge.WithHTTPClient].
	HTTPClient *http.Client

	// ClientID is the OAuth app client ID used by the interactive device-flow
	// login ([Authenticator]). Empty falls back to [DefaultClientIDEnv]; when
	// neither is set, Login reports [forge.ErrNotSupported] and the caller
	// prompts for a token manually.
	ClientID string `json:"client_id" yaml:"client_id"`

	// Scopes overrides the OAuth scopes requested at login. Empty uses a
	// sensible default (repo, read:org, gist).
	Scopes []string `json:"scopes" yaml:"scopes"`
}

Settings contains the typed configuration needed to construct a GitHub release provider, without binding it to any config container.

The shape matches every other provider: a release source, a forge.CredentialSource, and the endpoint overrides this forge needs.

func SettingsFromConfig 

func SettingsFromConfig(ep forge.Endpoint, cfg forge.Config) Settings

SettingsFromConfig adapts the github config subtree into typed provider settings. It preserves the existing `url.*` and `auth.client_id` keys.

The credential composition IS the precedence, and it is written here rather than hidden in a resolution chain: the configured key, then the well-known variable. A caller wanting a different order — or a different key entirely — builds their own forge.CredentialSource and assigns Settings.Credential.

A nil cfg is not special-cased: forge.ConfigCredential treats a nil config as contributing nothing, so a config-free public lookup still reaches the environment fallback. cfg is the ROOT configuration, not a pre-scoped subtree: the endpoint resolves its own section, because which subtree a source reads is part of what the endpoint means. An unnamed endpoint reads `github`; a named one reads `github.<name>`, which is how two GitHub sources — two credentials, or an Enterprise instance beside github.com — stop sharing one set of keys.

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.