Documentation
¶
Overview ¶
Package forgejo provides access to Forgejo via the forgejo-sdk.
Index ¶
- type Client
- func (c *Client) CloseIssue(ctx context.Context, repo string, number int) error
- func (c *Client) ClosePR(ctx context.Context, repo string, number int) error
- func (c *Client) CommentIssue(ctx context.Context, repo string, number int, body string) error
- func (c *Client) CommentPR(ctx context.Context, repo string, number int, body string) error
- func (c *Client) CreateIssue(ctx context.Context, in operations.IssueInput) (operations.IssueDetail, error)
- func (c *Client) CreatePR(ctx context.Context, in operations.PRInput) (operations.PRDetail, error)
- func (c *Client) CreateRepo(ctx context.Context, in operations.RepoInput) (operations.Repo, error)
- func (c *Client) DeleteRepo(ctx context.Context, fullName string) error
- func (c *Client) FetchSpec(ctx context.Context, repo string, number int) (operations.FetchSpec, error)
- func (c *Client) GetIssue(ctx context.Context, repo string, number int) (operations.IssueDetail, error)
- func (c *Client) GetPR(ctx context.Context, repo string, number int) (operations.PRDetail, error)
- func (c *Client) ListIssues(ctx context.Context) ([]operations.Issue, error)
- func (c *Client) ListPRs(ctx context.Context) ([]operations.PR, error)
- func (c *Client) ListProjects(ctx context.Context) ([]operations.Project, error)
- func (c *Client) ListRepos(ctx context.Context) ([]operations.Repo, error)
- func (c *Client) ListRuns(ctx context.Context, fullName string) ([]operations.Run, error)
- func (c *Client) ListWorkflows(ctx context.Context, fullName string) ([]operations.Workflow, error)
- func (c *Client) MergePR(ctx context.Context, repo string, number int, opts operations.MergeOptions) error
- func (c *Client) Name() string
- func (c *Client) PRDiff(ctx context.Context, repo string, number int) (string, error)
- func (c *Client) RenameRepo(ctx context.Context, fullName, newName string) (operations.Repo, error)
- func (c *Client) SetForgeLabel(label string)
- func (c *Client) SetInstance(name string)
- func (c *Client) SetVisibility(ctx context.Context, fullName string, private bool) (operations.Repo, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
func New ¶
func New(cfg operations.ForgejoConfig) (*Client, error)
New builds a Forgejo client from the given credentials.
func (*Client) CloseIssue ¶
CloseIssue closes an issue.
func (*Client) CommentIssue ¶
CommentIssue adds a comment to an issue.
func (*Client) CreateIssue ¶
func (c *Client) CreateIssue(ctx context.Context, in operations.IssueInput) (operations.IssueDetail, error)
CreateIssue opens a new issue.
func (*Client) CreatePR ¶
func (c *Client) CreatePR(ctx context.Context, in operations.PRInput) (operations.PRDetail, error)
CreatePR opens a pull request.
func (*Client) CreateRepo ¶
func (c *Client) CreateRepo(ctx context.Context, in operations.RepoInput) (operations.Repo, error)
CreateRepo creates a repository in the authenticated user's namespace, or in an organization when in.Owner is set.
func (*Client) DeleteRepo ¶
DeleteRepo deletes a repository. fullName is owner/name.
func (*Client) FetchSpec ¶
func (c *Client) FetchSpec(ctx context.Context, repo string, number int) (operations.FetchSpec, error)
FetchSpec returns how to fetch a pull request head locally.
Forgejo mirrors GitHub's refs/pull/N/head namespace, so the head commit is fetchable even for pull requests opened from a fork.
func (*Client) GetIssue ¶
func (c *Client) GetIssue(ctx context.Context, repo string, number int) (operations.IssueDetail, error)
GetIssue returns a single issue in full.
func (*Client) ListIssues ¶
ListIssues returns open issues assigned to the authenticated user.
The /repos/issues/search endpoint returns pull requests too unless type=issues is set (the SDK sends type= only when IssueType is non-empty), and it does not restrict results to the current user. Resolve the authenticated user and keep only issues assigned to them, mirroring the GitHub (filter=assigned) and GitLab (scope=assigned_to_me) semantics.
func (*Client) ListProjects ¶
ListProjects returns ErrNotSupported: Forgejo has no projects/boards API. The web UI has no project boards either, so there is nothing to enumerate; issues and pull requests remain available.
func (*Client) ListRuns ¶
ListRuns lists Actions task runs for a repository. fullName is owner/name.
The SDK does not wrap the Actions API, so /repos/{owner}/{repo}/actions/tasks is called directly. Tasks carry the workflow name, branch and run number, which map onto the unified Run shape.
func (*Client) ListWorkflows ¶
ListWorkflows lists Actions workflow definitions for a repository. fullName is owner/name.
Forgejo has no endpoint that enumerates workflows (unlike GitHub's /actions/workflows), so the workflow directories are listed from the default branch instead. Forgejo reads .forgejo/workflows first and falls back to .github/workflows; both are reported here, deduplicated by file name.
func (*Client) MergePR ¶
func (c *Client) MergePR(ctx context.Context, repo string, number int, opts operations.MergeOptions) error
MergePR merges a pull request.
func (*Client) RenameRepo ¶
RenameRepo renames a repository. fullName is owner/name.
func (*Client) SetForgeLabel ¶
SetForgeLabel overrides the forge label the client stamps on returned resources. Used to give user-named aliases (e.g. "gitea") the right identity in listings while the Forgejo client does the API work.
func (*Client) SetInstance ¶
SetInstance names this client's instance (default: the forge type).
func (*Client) SetVisibility ¶
func (c *Client) SetVisibility(ctx context.Context, fullName string, private bool) (operations.Repo, error)
SetVisibility changes whether a repository is private. fullName is owner/name.