gitlab

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: 16 Imported by: 0

README

forge-gitlab

GitLab release provider for forge

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 contract for GitLab releases, using gitlab-org/api/client-go.

It is its own module so a tool that only supports GitLab never compiles GitHub's client, Gitea's, or Bitbucket's. A depfootprint guard asserts that.

Use it

Blank-import to register, then resolve through the registry — your code never names a GitLab type:

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

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

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

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

Configuration

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

[!IMPORTANT] gitlab.auth.env and gitlab.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.

Endpoint.Host selects a self-hosted instance; empty means gitlab.com. A token is optional — public projects resolve unauthenticated.

Platform differences

GitLab's release model differs from GitHub's in ways the shared contract cannot hide:

Contract On GitLab
GetDraft() Always false — GitLab has no draft-release concept, so there is nothing to report. Code branching on it will treat every GitLab release as published.
DownloadReleaseAsset redirect Always empty. Only GitHub redirects asset requests to a CDN.
GetLatestRelease Fetches the first page of releases sorted newest-first, rather than a dedicated latest endpoint.

Security

The PRIVATE-TOKEN credential is attached only to asset downloads on the configured instance, via forge.HostTrusted. Asset URLs come from release metadata that a release author controls, so an unpinned credential is an exfiltration primitive. Host, port and scheme must all match, which also refuses a downgrade to plaintext HTTP.

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 gitlab implements the VCS release provider for GitLab repositories, supporting both public and token-authenticated access; the owner may be a slash-separated group path passed through to the GitLab API. Provider construction uses package-owned Settings; GTB config integration lives in SettingsFromConfig.

Index

Constants

View Source 
const DefaultClientIDEnv = "GITLAB_CLIENT_ID"

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

View Source 
const DefaultTokenEnv = "GITLAB_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 variable name — and it is what CI injects, so it is preserved as a composed default rather than dropped.

Variables

View Source 
var ErrCredentialWithClient = errors.NewSentinel("forge_gitlab.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_gitlab.endpoint_with_client",
	"an API URL was supplied alongside an injected client; the client already has its own")

ErrEndpointWithClient reports an API URL supplied alongside an injected client.

Settings.APIURL configures the client this module would otherwise build. Alongside one that already exists it is read by nothing, so a caller setting it is addressing an instance the provider will never contact.

Functions

func NewProviderFromClient added in v0.12.0 

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

NewProviderFromClient builds a provider on a go-gitlab 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, which is the point of the rung: a caller reaching for it has authentication go-gitlab can express and this module cannot. Settings.Credential must be nil, and supplying one is ErrCredentialWithClient.

Asset downloads are ANONYMOUS at this rung

This is the consequence worth knowing before choosing it, and it is specific to GitLab. A release asset here is a LINK — an arbitrary URL a release author supplied — so fetching it is not an API call and go-gitlab never makes it. This provider therefore fetches it directly, and authenticates that request by attaching PRIVATE-TOKEN itself.

It cannot do that with an injected client. go-gitlab exposes no way to read the credential back: every method on its Client was checked at v2.58.0, and none yields the token or the AuthSource. Its own arbitrary-URL method, NewRequestToURL, does attach the credential — and follows a redirect off the instance still carrying it, which is the leak this module's credential pinning exists to prevent, so it is not an option either.

A PUBLIC asset downloads normally. A private one will fail. A caller who needs authenticated downloads should use a lower rung — forge.WithHTTPTransport, or Settings with a Credential — where this module still owns the credential and the redirect policy that keeps it on the pinned host.

The API base is read from the CLIENT rather than from Settings, because the client is what will make the requests.

func NewReleaseProvider 

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

NewReleaseProvider builds a GitLab release provider from explicit typed settings. A public repository needs no credential; Host selects the instance, empty means gitlab.com, and APIURL can override the derived API endpoint.

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 GitLabReleaseProvider 

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

GitLabReleaseProvider implements forge.Provider.

func (*GitLabReleaseProvider) CreateIssue added in v0.4.0 

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

CreateIssue files an issue.

Sanitisation

Title and Body go through forge.Sanitise unless the draft opts out, and the idempotency trailer is appended AFTERWARDS. The order is contractual: an opaque key of 41 or more characters trips redact's long-token pattern, so sanitising last would rewrite the key and the pre-create search would then look for one the issue does not carry — breaking at-most-once silently.

At-most-once

GitLab offers no idempotency primitive. Its create endpoint accepts an `iid`, which would serve, but it is documented as requiring administrator or project owner rights — incompatible with the least-privilege token this capability is meant to be usable with. So the key is written into the body as a searchable marker and looked for first.

func (*GitLabReleaseProvider) CreateSnippet added in v0.8.0 

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

CreateSnippet creates a snippet in the requested scope.

func (*GitLabReleaseProvider) DeleteSnippet added in v0.8.0 

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

DeleteSnippet removes a snippet by its opaque ID.

func (*GitLabReleaseProvider) DownloadReleaseAsset 

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

DownloadReleaseAsset is more complex for GitLab.

func (*GitLabReleaseProvider) GetFile added in v0.3.0 

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

GetFile reads one file at a ref without cloning.

The bound is enforced by asking for the size FIRST. client-go's GetRawFile copies the whole response body into a buffer before returning it, so checking len() afterwards would be a measurement rather than a limit. GetRawFileMetaData issues a HEAD and reports Size, which lets an oversized file be refused before a byte of it is fetched.

The length is re-checked after the read, catching a file that grew between the two calls. What remains uncovered is a server that LIES about the size — which is acceptable here in a way it would not be for a release asset, because this URL is the pinned API host the provider authenticated against rather than a URL a release author chose.

func (*GitLabReleaseProvider) GetIssue added in v0.4.0 

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

GetIssue returns one issue by its per-project number (GitLab's iid).

func (*GitLabReleaseProvider) GetLatestRelease 

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

func (*GitLabReleaseProvider) GetReleaseByTag 

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

func (*GitLabReleaseProvider) GetSite added in v0.3.0 

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

GetSite reports a project's GitLab Pages site.

Reading Pages settings requires the Maintainer or Owner role, so a 403 is routine rather than exceptional here — and it is deliberately NOT folded into ErrNotFound. Telling a caller "this project has no site" when the truth is "your token could not ask" is how a repository silently drops out of a corpus.

func (*GitLabReleaseProvider) GetSnippet added in v0.8.0 

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

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

func (*GitLabReleaseProvider) ListComments added in v0.4.0 

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

ListComments yields an issue's comments.

Emulating Since

GitLab's notes endpoint has no created_after parameter — ListIssueNotesOptions carries only order_by and sort. So Since is honoured by asking for newest-first and stopping as soon as a note older than Since appears: the caller still pays only for what it asked for, rather than for the whole history filtered afterwards.

The consequence is that this provider yields NEWEST-FIRST while a forge with a server-side filter yields oldest-first. The contract promises no order for exactly this reason, because making them agree would mean buffering everything — which is what Since exists to avoid.

func (*GitLabReleaseProvider) ListReleases 

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

ListReleases returns up to limit releases, paginating across GitLab's pages (signalled by the X-Next-Page header) until the limit is met or history is exhausted. A limit <= 0 means "no explicit bound" — the natural first page. See forge.Provider.

func (*GitLabReleaseProvider) ListRepositories added in v0.3.0 

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

ListRepositories enumerates the projects in a GitLab group.

WithShared is pinned to false, and that is the load-bearing line in this file. GitLab documents with_shared as defaulting to TRUE, so the natural call returns projects merely SHARED into the group alongside those owned by it — carrying their own, foreign namespace paths. A caller whose question is "is this in my group?" would get a different question answered, in the permissive direction, and the forge conformance harness checks the containment property precisely because this default is invisible in any fixture without a shared project.

func (*GitLabReleaseProvider) ListSnippets added in v0.8.0 

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

ListSnippets returns the snippets in scope, without file content.

func (*GitLabReleaseProvider) Login added in v0.2.0 

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

Login implements the optional forge.Authenticator capability via GitLab'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 (*GitLabReleaseProvider) SearchIssues added in v0.4.0 

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

SearchIssues yields issues matching q.

GitLab searches title and description server-side via `search` + `in`, so the text filter costs nothing extra here — unlike a forge whose search is weaker and has to filter client-side.

func (*GitLabReleaseProvider) UploadKey added in v0.2.0 

func (p *GitLabReleaseProvider) 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 GitLab'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.

It returns an error wrapping forge.ErrNotSupported when no token is configured, since GitLab's key API requires authentication — the caller then instructs the user to add the key manually.

type Settings 

type Settings struct {
	// Endpoint addresses this instance. Type is [forge.SourceTypeGitLab]; Host
	// selects the instance, empty meaning gitlab.com; Name selects which
	// configured source this is and scopes the configuration subtree read by
	// [SettingsFromConfig].
	Endpoint forge.Endpoint
	APIURL   string `json:"api_url" yaml:"api_url"`

	// Credential yields the token this provider authenticates with.
	//
	// Nil is not an error: [NewReleaseProvider] 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 the PRIVATE-TOKEN
	// sensitive-header policy its downloads depend on. 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 for asset downloads; 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 the provider reports the capability as unsupported.
	ClientID string `json:"client_id" yaml:"client_id"`

	// Scopes overrides the OAuth scopes requested at login. Empty uses a
	// sensible default (GitLab `api`).
	Scopes []string `json:"scopes" yaml:"scopes"`
}

Settings contains the typed configuration needed to construct a GitLab release provider without binding the provider to GTB config.

Fields are populated by the config adapter via the narrow forge.Config seam, not decoded with mapstructure. The json/yaml tags are for documentation and serialisation only.

func SettingsFromConfig 

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

SettingsFromConfig adapts the gitlab config subtree into typed provider settings. It preserves the existing `url.api` 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 `gitlab`; a named one reads `gitlab.<name>`, which is how a self-hosted instance and gitlab.com stop sharing one credential and one url.api.

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.