github

github

import "github.com/tagoro9/fotingo/internal/github"

Index

• Variables
• func FetchLatestReleaseTag(ctx context.Context, client *http.Client, owner string, repo string) (string, error)
• type CreatePROptions
• type CreateReleaseOptions
• type Github
  • func New(git git.Git, cfg *viper.Viper) (Github, error)
  • func NewAuthOnly(cfg *viper.Viper) (Github, error)
  • func NewAuthOnlyWithOptions(cfg *viper.Viper, allowPrompt bool) (Github, error)
  • func NewWithHTTPClient(g git.Git, cfg *viper.Viper, httpClient *http.Client, baseURL string) (Github, error)
  • func NewWithHTTPClientAndRepo(g git.Git, cfg *viper.Viper, httpClient *http.Client, baseURL, owner, repo string) (Github, error)
  • func NewWithOptions(git git.Git, cfg *viper.Viper, allowPrompt bool) (Github, error)
• type GithubConfig
• type Label
• type PullRequest
• type Release
• type Team
  • func (t Team) Canonical() string
• type User

Variables

var ErrAuthRequired = errors.New("github authentication required; run `fotingo login` interactively")

var ErrOAuthClientIDMissing = errors.New("github oauth client id is missing in this build; use `fotingo login` with API token auth or rebuild with oauth ldflags")

func FetchLatestReleaseTag

func FetchLatestReleaseTag(ctx context.Context, client *http.Client, owner string, repo string) (string, error)

FetchLatestReleaseTag fetches the latest release tag for a public repository without requiring authentication.

type CreatePROptions

CreatePROptions contains the options for creating a pull request

type CreatePROptions struct {
    Title string
    Body  string
    Head  string
    Base  string
    Draft bool
}

type CreateReleaseOptions

CreateReleaseOptions contains the options for creating a release

type CreateReleaseOptions struct {
    TagName         string
    TargetCommitish string
    Name            string
    Body            string
    Draft           bool
    Prerelease      bool
}

type Github

type Github interface {
    auth.OauthService
    config.ConfigurableService
    // GetPullRequestUrl returns the URL of the pull request for current branch or an error if it can't be found
    GetPullRequestUrl() (string, error)
    // GetCurrentUser returns the information about the current authenticated user
    GetCurrentUser() (*hub.User, error)
    // CreatePullRequest creates a new pull request
    CreatePullRequest(opts CreatePROptions) (*PullRequest, error)
    // GetLabels returns all labels from the repository
    GetLabels() ([]Label, error)
    // AddLabelsToPR adds labels to a pull request
    AddLabelsToPR(prNumber int, labels []string) error
    // GetCollaborators returns repository collaborators for reviewer selection
    GetCollaborators() ([]User, error)
    // GetOrgMembers returns organization members for participant selection
    GetOrgMembers() ([]User, error)
    // GetTeams returns organization teams for team reviewer selection
    GetTeams() ([]Team, error)
    // RequestReviewers requests reviewers on a pull request
    RequestReviewers(prNumber int, reviewers []string, teamReviewers []string) error
    // AssignUsersToPR assigns users to a pull request
    AssignUsersToPR(prNumber int, assignees []string) error
    // DoesPRExistForBranch checks if a PR exists for a given branch
    DoesPRExistForBranch(branch string) (bool, *PullRequest, error)
    // CreateRelease creates a GitHub release
    CreateRelease(opts CreateReleaseOptions) (*Release, error)
}

func New

func New(git git.Git, cfg *viper.Viper) (Github, error)

func NewAuthOnly

func NewAuthOnly(cfg *viper.Viper) (Github, error)

func NewAuthOnlyWithOptions

func NewAuthOnlyWithOptions(cfg *viper.Viper, allowPrompt bool) (Github, error)

func NewWithHTTPClient

func NewWithHTTPClient(g git.Git, cfg *viper.Viper, httpClient *http.Client, baseURL string) (Github, error)

NewWithHTTPClient returns a new GitHub client using the provided HTTP client and base URL. This bypasses OAuth authentication and is intended for testing with mock servers.

func NewWithHTTPClientAndRepo

func NewWithHTTPClientAndRepo(g git.Git, cfg *viper.Viper, httpClient *http.Client, baseURL, owner, repo string) (Github, error)

NewWithHTTPClientAndRepo creates a GitHub client with explicit owner/repo, bypassing remote URL parsing.

func NewWithOptions

func NewWithOptions(git git.Git, cfg *viper.Viper, allowPrompt bool) (Github, error)

type GithubConfig

type GithubConfig struct {
    Token string
}

type Label

Label represents a GitHub label

type Label struct {
    Name        string
    Description string
    Color       string
}

type PullRequest

PullRequest represents a GitHub pull request

type PullRequest struct {
    Number  int
    URL     string
    HTMLURL string
}

type Release

Release represents a GitHub release

type Release struct {
    ID      int64
    TagName string
    Name    string
    URL     string
    HTMLURL string
}

type Team

Team represents a GitHub organization team.

type Team struct {
    Organization string
    Slug         string
    Name         string
    Description  string
}

func (Team) Canonical

func (t Team) Canonical() string

Canonical returns the canonical team identifier (<org>/<team-slug>).

type User

User represents a GitHub user

type User struct {
    Login string
    Name  string
}

Generated by gomarkdoc