github

Documentation

Overview

Package github provides utilities for interacting with the GitHub API.

Index

• type Client
  • func NewClient(ctx context.Context, token string, opts ...ClientOption) (*Client, error)
  • func (c *Client) CreateReleasePR(ctx context.Context, req PRRequest) (*PRResult, error)
• type ClientOption
  • func WithFileReader(fr FileReader) ClientOption
• type FileReader
• type PRCreator
• type PRRequest
  • func (r *PRRequest) Validate() error
• type PRResult

Types

type Client

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

Client wraps the GitHub API client and implements PRCreator.

func NewClient

func NewClient(ctx context.Context, token string, opts ...ClientOption) (*Client, error)

NewClient creates a new GitHub client with the provided token. Optional ClientOption functions can be provided to customize the client behavior.

func (*Client) CreateReleasePR

func (c *Client) CreateReleasePR(ctx context.Context, req PRRequest) (*PRResult, error)

CreateReleasePR creates a new branch with the modified files and opens a PR.

type ClientOption

type ClientOption func(*Client)

ClientOption is a functional option for configuring the Client.

func WithFileReader

func WithFileReader(fr FileReader) ClientOption

WithFileReader sets a custom FileReader implementation for the Client. This is useful for testing or when file reading needs to be customized.

type FileReader

type FileReader interface {
	// ReadFile reads the contents of a file at the given path.
	// It returns the file contents as a byte slice, or an error if the read fails.
	ReadFile(path string) ([]byte, error)
}

FileReader defines the interface for reading file contents. This abstraction allows for dependency injection and makes the client testable by enabling mock file systems.

type PRCreator

type PRCreator interface {
	// CreateReleasePR creates a new branch with the modified files and opens a PR.
	CreateReleasePR(ctx context.Context, req PRRequest) (*PRResult, error)
}

PRCreator defines the interface for creating pull requests.

type PRRequest

type PRRequest struct {
	Owner      string   // GitHub repository owner (required)
	Repo       string   // GitHub repository name (required)
	BaseBranch string   // Base branch for the PR (required, e.g., "main")
	HeadBranch string   // Feature branch to create (required)
	Title      string   // PR title (required)
	Body       string   // PR body/description
	Files      []string // Files to commit (required, must not be empty)
}

PRRequest contains the parameters for creating a pull request. All fields except Body are required.

func (*PRRequest) Validate

func (r *PRRequest) Validate() error

Validate checks that all required fields are set.

type PRResult

type PRResult struct {
	Number int
	URL    string
}

PRResult contains the result of creating a pull request.