github

package

v0.4.1-rc5 Latest Latest Go to latest Published: Dec 2, 2025 License: MIT Imports: 10 Imported by: 0

Details

Package github provides the GitHub implementation of the workitem provider.

This section is empty.

This section is empty.

func New(ctx context.Context, logger *slog.Logger, cfg *config.Config) (workitem.Provider, error)

New creates a new Provider by discovering the repository from the local git remote.

func NewWithClient(client *gh.Client, logger *slog.Logger, owner, repo string) workitem.Provider

NewWithClient creates a new Provider with an existing GitHub client.

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

Provider implements the workitem.Provider interface for GitHub Issues.

func (p *Provider) CreateItem(
	ctx context.Context,
	item workitem.WorkItem,
) (*workitem.WorkItem, error)

CreateItem creates a new work item in the backend system.

func (p *Provider) CreateLabel(ctx context.Context, label workitem.Label) (*workitem.Label, error)

CreateLabel creates a new label in the backend system.

func (p *Provider) GetItem(
	ctx context.Context,
	number int,
	withComments bool,
) (*workitem.WorkItem, error)

GetItem retrieves a single work item by its public number, optionally fetching comments.

func (p *Provider) ListItems(
	ctx context.Context,
	options workitem.ListOptions,
) ([]workitem.WorkItem, error)

ListItems retrieves a collection of work items based on the provided options.

func (p *Provider) SearchItems(ctx context.Context, query string) ([]workitem.WorkItem, error)

SearchItems uses a provider-specific query string to find work items.

func (p *Provider) UpdateItem(
	ctx context.Context,
	number int,
	item workitem.WorkItem,
) (*workitem.WorkItem, error)

UpdateItem updates an existing work item in the backend system.