forgeapi

package module

Go to main page

Versions in this module

v1

v1.3.0-dev.2

Oct 11, 2026

v1.2.0

Oct 11, 2026

Changes in this version

+ const CodeListSinceInvalid

+ const CodeRunUndated

type ConnectionCaps

+ Product Product

type ListOption

+ func WithSince(t time.Time) ListOption

type ListSettings

+ Since time.Time

+ SinceSet bool

type PartialReason

+ const PartialForbidden

+ type Product int

+ const ProductForgejo

+ const ProductGitHub

+ const ProductGitLab

+ const ProductGitea

+ const ProductUnknown

+ func (p Product) String() string

type Run

+ Ref RunRef

+ StartedAt time.Time

+ Trigger RunTrigger

+ type RunRef struct

+ ID int64

+ Number int64

+ type RunTrigger int

+ const TriggerManual

+ const TriggerOther

+ const TriggerPullRequest

+ const TriggerPush

+ const TriggerSchedule

+ const TriggerUnknown

+ func (r RunTrigger) String() string

v1.1.0-dev.9

Oct 11, 2026

v1.1.0-dev.8

Oct 10, 2026

v1.1.0-dev.7

Oct 10, 2026

v1.1.0-dev.5

Oct 10, 2026

v1.1.0-dev.2

Oct 9, 2026

v1.1.0-dev.1

Oct 9, 2026

v1.0.4

Oct 10, 2026

v1.0.3

Oct 9, 2026

v1.0.3-dev.1

Oct 8, 2026

v1.0.2

Oct 6, 2026

v1.0.1

Oct 5, 2026

v1.0.0

Oct 5, 2026

Changes in this version

+ const BudgetRemainingUnknown

+ const CodeAPIVersionRetired

+ const CodeAlreadyEnqueued

+ const CodeAnonymousRefused

+ const CodeBranchCannotMerge

+ const CodeBudgetInvalid

+ const CodeCapabilityUnsupported

+ const CodeConnectionInvalid

+ const CodeCursorInvalid

+ const CodeFamilyUndetected

+ const CodeGrantDenied

+ const CodeGrantExpired

+ const CodeGrantUnsupported

+ const CodeHeaderReserved

+ const CodeLabelPageTruncated

+ const CodeListOwnerInvalid

+ const CodeListStateInvalid

+ const CodeMissingSHA

+ const CodeMutationsDisabled

+ const CodeNoMergePermission

+ const CodeNotMergeable

+ const CodeOwnerUnresolved

+ const CodePRNotFound

+ const CodePageBoundInvalid

+ const CodePlaintextRefused

+ const CodePrivateAddressRefused

+ const CodeReconnectRequired

+ const CodeRedirectHopCap

+ const CodeRedirectPortRefused

+ const CodeRefInvalid

+ const CodeRepoArchived

+ const CodeRepoOrPRNotVisible

+ const CodeRepoRefInvalid

+ const CodeRepoRefStale

+ const CodeScopeInsufficient

+ const CodeStaleHead

+ const CodeStrategyNotAllowed

+ const CodeValidation

+ const DefaultListPages

+ const DefaultMutationConcurrency

+ const DefaultMutationInterval

+ const DefaultMutationReserve

+ const DefaultOperationTimeout

+ const DefaultPageBound

+ const DefaultReadConcurrency

+ const DefaultRefreshLead

+ const DefaultRetries

+ const DefaultStatusPages

+ const DefaultStatusReadsPerInterval

+ const DefaultStatusTimePerInterval

+ const DiagIDLength

+ const MaxRedirectHops

+ const QueuePositionUnknown

+ const RepoIDPrefix

+ func ReservedHeaders() []string

+ func ValidateCursor(c Cursor) error

+ func ValidateOwner(family Family, owner string) error

+ func ValidateRef(ref string) error

+ func ValidateSelector(family Family, selector string) error

+ type Account struct

+ Email string

+ Login string

+ Name string

+ Scopes []string

+ WebURL string

+ type ActionState struct

+ AutoMergeArmed Support

+ Checks CheckState

+ ChecksFailing int

+ ChecksNeutral int

+ ChecksPassing int

+ ChecksPending int

+ ChecksTotal int

+ ChecksUnknown int

+ MergeBlocked MergeBlockReason

+ Mergeable Support

+ QueuePosition int

+ QueueState QueueState

+ type Budget struct

+ ListPages int

+ MutationConcurrency int

+ MutationInterval time.Duration

+ OperationTimeout time.Duration

+ ReadConcurrency int

+ Retries int

+ StatusPages int

+ StatusReadsPerInterval int

+ StatusTimePerInterval time.Duration

+ func DefaultBudget() Budget

+ type BudgetState struct

+ LastCost int

+ Remaining int

+ Reset time.Time

+ RotationCursor RotationCursor

+ type Capabilities interface

+ ConnectionCaps func(ctx context.Context) (ConnectionCaps, error)

+ GrantCaps func(ctx context.Context) (GrantCaps, error)

+ RepoAffordances func(ctx context.Context, repo RepoRef) (RepoAffordances, error)

+ type Capability string

+ const CapCanPush

+ const CapHasIssues

+ const CapMergeTrain

+ const CapReadMergeState

+ const CapRerunChecks

+ type CheckContext struct

+ Description string

+ Name string

+ State CheckState

+ TargetURL string

+ type CheckState int

+ const CheckFailing

+ const CheckNeutral

+ const CheckPassing

+ const CheckPending

+ const CheckUnknown

+ func (c CheckState) String() string

+ type Checks interface

+ CommitStatus func(ctx context.Context, repo RepoRef, ref string) (CommitChecks, error)

+ ListRuns func(ctx context.Context, repo RepoRef, opts ...ListOption) (Page[Run], error)

+ type CommitChecks struct

+ Contexts []CheckContext

+ Failing int

+ Neutral int

+ Partial *Partial

+ Passing int

+ Pending int

+ Ref string

+ State CheckState

+ Successor *RepoRef

+ Total int

+ Unknown int

+ type Connection struct

+ APIBaseURL string

+ CABytes []byte

+ ClientCert []byte

+ ClientKey []byte

+ Headers []Header

+ Proxy string

+ WebBaseURL string

+ type ConnectionCaps struct

+ Caps map[Capability]Support

+ Ev map[Capability]Evidence

+ type Core interface

+ Close func()

+ type Counters struct

+ AddressRefusal func(family Family, kind string)

+ CapabilityContradicted func(family Family, capability Capability)

+ EnvelopeError func(family Family, errType string)

+ HelperDecline func(reason string)

+ HelperErase func(family Family)

+ NonDurableCredentialWrite func(family Family)

+ PartialResult func(family Family, reason PartialReason)

+ RateLimited func(family Family)

+ ReadDeferred func(family Family, op string)

+ RedirectHopCapExceeded func(family Family)

+ RedirectPortRefused func(family Family)

+ RefreshOutcome func(family Family, terminal CredState)

+ Retried func(family Family, op string)

+ SunsetSeen func(family Family)

+ UnknownEnumValue func(family Family, field string)

+ type CredKind int

+ const CredKindRotatingOAuth

+ const CredKindStaticPAT

+ const CredKindUnknown

+ func (k CredKind) String() string

+ type CredState int

+ const CredReconnectRequired

+ const CredRefreshDue

+ const CredRefreshing

+ const CredUnknown

+ const CredValid

+ func (s CredState) String() string

+ type CredentialSource interface

+ Kind func() CredKind

+ State func() CredState

+ Token func(ctx context.Context) (string, error)

+ type Cursor string

+ type Error struct

+ Capability Capability

+ Code string

+ DiagID string

+ Evidence Evidence

+ Family Family

+ Kind ErrorKind

+ Message string

+ Op string

+ RetryAfter time.Duration

+ Retryable bool

+ Status int

+ Successor *RepoRef

+ func (e *Error) Error() string

+ type ErrorKind int

+ const KindConflict

+ const KindForbidden

+ const KindNotFound

+ const KindNotMergeable

+ const KindRateLimited

+ const KindTransient

+ const KindUnauthorized

+ const KindUnknown

+ const KindUpstream

+ func (k ErrorKind) String() string

+ type Evidence struct

+ Detail string

+ Source EvidenceSource

+ type EvidenceSource string

+ const EvidenceDefault

+ const EvidenceMetadata

+ const EvidenceProbe

+ const EvidenceResponseBody

+ const EvidenceResponseHeader

+ const EvidenceSwagger

+ const EvidenceUnknown

+ const EvidenceVersion

+ func (s EvidenceSource) String() string

+ type Family int

+ const FamilyGitHub

+ const FamilyGitLab

+ const FamilyGitea

+ const FamilyUnknown

+ func (f Family) String() string

+ type Governor interface

+ BudgetState func() BudgetState

+ type GrantCaps struct

+ Caps map[Capability]Support

+ Ev map[Capability]Evidence

+ type Header struct

+ Name string

+ Value string

+ type Identity interface

+ Whoami func(ctx context.Context) (Account, error)

+ type Issue struct

+ Author string

+ Body string

+ CreatedAt time.Time

+ Labels []Label

+ Ref IssueRef

+ Repo RepoRef

+ State IssueState

+ Title string

+ UpdatedAt time.Time

+ WebURL string

+ type IssueRef struct

+ Number int

+ type IssueState int

+ const IssueStateClosed

+ const IssueStateOpen

+ const IssueStateUnknown

+ func (i IssueState) String() string

+ type Issues interface

+ CloseIssue func(ctx context.Context, repo RepoRef, issue IssueRef) (Issue, error)

+ CreateIssue func(ctx context.Context, repo RepoRef, req NewIssue) (Issue, error)

+ ListIssues func(ctx context.Context, repo RepoRef, opts ...ListOption) (Page[Issue], error)

+ ListMyIssues func(ctx context.Context, opts ...ListOption) (Page[Issue], error)

+ type Label struct

+ Color string

+ Description string

+ Name string

+ type Labels interface

+ ListLabels func(ctx context.Context, repo RepoRef, opts ...ListOption) (Page[Label], error)

+ type ListOption interface

+ func WithAfter(c Cursor) ListOption

+ func WithOwner(owner string) ListOption

+ func WithPageBound(n int) ListOption

+ func WithState(s ListState) ListOption

+ type ListSettings struct

+ After Cursor

+ Owner string

+ OwnerSet bool

+ PageBound int

+ State ListState

+ StateSet bool

+ func ResolveList(opts ...ListOption) (ListSettings, error)

+ type ListState int

+ const ListStateAll

+ const ListStateClosed

+ const ListStateMerged

+ const ListStateOpen

+ const ListStateUnknown

+ func (l ListState) String() string

+ type MergeBlockReason int

+ const MergeBlockBehind

+ const MergeBlockBlocked

+ const MergeBlockChecksFailing

+ const MergeBlockChecksRunning

+ const MergeBlockConflicts

+ const MergeBlockDraft

+ const MergeBlockNone

+ const MergeBlockUnknown

+ func (m MergeBlockReason) String() string

+ type MergeIntent int

+ const IntentDefault

+ const IntentNoSquash

+ const IntentSquash

+ func (m MergeIntent) String() string

+ type MergeOutcome struct

+ Code string

+ QueuePosition int

+ QueueState QueueState

+ State MergeOutcomeState

+ type MergeOutcomeState int

+ const MergeOutcomeAccepted

+ const MergeOutcomeEnqueued

+ const MergeOutcomeInFlight

+ const MergeOutcomeMerged

+ const MergeOutcomeRefused

+ const MergeOutcomeUnknown

+ func (m MergeOutcomeState) String() string

+ type MergeRequest struct

+ AutoMerge bool

+ DeleteBranch bool

+ HeadSHA string

+ Intent MergeIntent

+ Strategy string

+ type MergeStatus struct

+ Merged Support

+ Queue QueueState

+ Successor *RepoRef

+ WebURL string

+ type Merges interface

+ MergePR func(ctx context.Context, repo RepoRef, pr PRRef, req MergeRequest) (MergeOutcome, error)

+ MergeStatus func(ctx context.Context, repo RepoRef, pr PRRef) (MergeStatus, error)

+ type NewIssue struct

+ Body string

+ Labels []string

+ Title string

+ type NewPullRequest struct

+ Body string

+ Draft bool

+ Labels []string

+ SourceBranch string

+ TargetBranch string

+ Title string

+ type NewRelease struct

+ Body string

+ Draft bool

+ Name string

+ Prerelease bool

+ TagName string

+ Target string

+ type Option interface

+ func WithAttemptObserver(wrap func(next http.RoundTripper) http.RoundTripper) Option

+ func WithCounters(c Counters) Option

+ func WithCredentialSource(src CredentialSource) Option

+ func WithListPages(n int) Option

+ func WithLogger(l *slog.Logger) Option

+ func WithMutationConcurrency(n int) Option

+ func WithMutationInterval(d time.Duration) Option

+ func WithMutationReserve(n int) Option

+ func WithMutations(allowed bool) Option

+ func WithOperationTimeout(d time.Duration) Option

+ func WithPlaintextHTTP(allowed bool) Option

+ func WithPrivateAddresses(allowed bool) Option

+ func WithReadConcurrency(n int) Option

+ func WithRefreshLead(d time.Duration) Option

+ func WithRequestObserver(wrap func(next http.RoundTripper) http.RoundTripper) Option

+ func WithRetries(n int) Option

+ func WithRotationCursor(c RotationCursor) Option

+ func WithStatusPages(n int) Option

+ func WithStatusReadsPerInterval(n int) Option

+ func WithStatusTimePerInterval(d time.Duration) Option

+ func WithWireTransport(rt http.RoundTripper) Option

+ type PRRef struct

+ Number int

+ Sigil string

+ type PRState int

+ const PRStateClosed

+ const PRStateMerged

+ const PRStateOpen

+ const PRStateUnknown

+ func (p PRState) String() string

+ type Page struct

+ Items []T

+ Next Cursor

+ Partial *Partial

+ Successor *RepoRef

+ type Partial struct

+ Fetched int

+ OmittedAtLeast int

+ Reason PartialReason

+ type PartialReason int

+ const PartialBudget

+ const PartialGraphQLPartial

+ const PartialLabelsNotApplied

+ const PartialPaginationCap

+ const PartialRateLimited

+ const PartialResultWindow

+ const PartialUnknown

+ func (p PartialReason) String() string

+ type PullRequest struct

+ Action ActionState

+ Author string

+ Body string

+ CreatedAt time.Time

+ Draft bool

+ HeadSHA string

+ Labels []Label

+ Partial *Partial

+ Ref PRRef

+ Repo RepoRef

+ SourceBranch string

+ SourceRepo RepoRef

+ State PRState

+ TargetBranch string

+ Title string

+ UpdatedAt time.Time

+ WebURL string

+ type PullRequests interface

+ ClosePR func(ctx context.Context, repo RepoRef, pr PRRef) (PullRequest, error)

+ CreatePR func(ctx context.Context, repo RepoRef, req NewPullRequest) (PullRequest, error)

+ ListMyPRs func(ctx context.Context, opts ...ListOption) (Page[PullRequest], error)

+ ListPRs func(ctx context.Context, repo RepoRef, opts ...ListOption) (Page[PullRequest], error)

+ ReadPR func(ctx context.Context, repo RepoRef, pr PRRef) (PullRequest, error)

+ ReopenPR func(ctx context.Context, repo RepoRef, pr PRRef) (PullRequest, error)

+ RerunFailedChecks func(ctx context.Context, repo RepoRef, pr PRRef, headSHA string) error

+ type QueueState int

+ const QueueAwaitingChecks

+ const QueueLocked

+ const QueueMergeable

+ const QueueNone

+ const QueueQueued

+ const QueueUnknown

+ const QueueUnmergeable

+ func (q QueueState) String() string

+ type Release struct

+ Body string

+ Draft bool

+ Name string

+ Prerelease bool

+ PublishedAt time.Time

+ TagName string

+ WebURL string

+ type Releases interface

+ CreateRelease func(ctx context.Context, repo RepoRef, req NewRelease) (Release, error)

+ ListReleases func(ctx context.Context, repo RepoRef, opts ...ListOption) (Page[Release], error)

+ type RepoAffordances struct

+ CanPush Support

+ DefaultBranch string

+ Ev map[Capability]Evidence

+ HasIssues Support

+ MergeStrategies []string

+ MergeTrain Support

+ type RepoRef struct

+ DisplayPath string

+ Family Family

+ ID string

+ Selector string

+ func DecodeRepoRef(id string, family Family) (RepoRef, error)

+ func (r RepoRef) Encode() string

+ type Repos interface

+ ListRepos func(ctx context.Context, opts ...ListOption) (Page[Repository], error)

+ type Repository struct

+ Affordances RepoAffordances

+ Archived bool

+ CloneURL string

+ Description string

+ Fork bool

+ Private bool

+ Ref RepoRef

+ UpdatedAt time.Time

+ WebURL string

+ type RotationCursor string

+ type Run struct

+ Branch string

+ CreatedAt time.Time

+ HeadSHA string

+ Name string

+ Repo RepoRef

+ State CheckState

+ UpdatedAt time.Time

+ WebURL string

+ type Settings struct

+ AttemptObserver func(next http.RoundTripper) http.RoundTripper

+ Budget Budget

+ Counters Counters

+ Credential CredentialSource

+ Logger *slog.Logger

+ MutationReserve int

+ Mutations bool

+ PlaintextHTTP bool

+ PrivateAddresses bool

+ RefreshLead time.Duration

+ RequestObserver func(next http.RoundTripper) http.RoundTripper

+ RotationCursor RotationCursor

+ WireTransport http.RoundTripper

+ func Resolve(opts ...Option) Settings

+ type Support int

+ const SupportNo

+ const SupportUnknown

+ const SupportYes

+ func (s Support) String() string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL