api

Documentation

Index

• Variables
• func CloseMilestone(ctx context.Context, opts CloseMilestoneOptions) (*github.Milestone, error)
• func ConvertMilestoneToMap(milestone *github.Milestone, fields []string) map[string]any
• func CreateMilestone(ctx context.Context, opts CreateMilestoneOptions) (*github.Milestone, error)
• func FetchOwnerAndRepoFromURL(url *url.URL) (*string, *string, error)
• func GetMilestone(ctx context.Context, repo ghrepo.Interface, number int) (*github.Milestone, error)
• func GetMilestoneByURL(ctx context.Context, url *url.URL) (*github.Milestone, error)
• func Milestones(ctx context.Context, repo ghrepo.Interface, filterOpts FilterOptions) ([]*github.Milestone, error)
• func ReopenMilestone(ctx context.Context, opts ReopenMilestoneOptions) (*github.Milestone, error)
• func WithBaseURL(baseURL string) clientOption
• func WithToken(token string) clientOption
• type CloseMilestoneOptions
• type CreateMilestoneOptions
• type FilterOptions
• type ReopenMilestoneOptions

Variables

var MilestoneFields = []string{
	"url",
	"id",
	"number",
	"state",
	"title",
	"description",
	"creator",
	"openIssues",
	"closedIssues",
	"createdAt",
	"updatedAt",
	"closedAt",
	"dueOn",
}

Functions

func CloseMilestone

func CloseMilestone(ctx context.Context, opts CloseMilestoneOptions) (*github.Milestone, error)

func ConvertMilestoneToMap

func ConvertMilestoneToMap(milestone *github.Milestone, fields []string) map[string]any

func CreateMilestone

func CreateMilestone(ctx context.Context, opts CreateMilestoneOptions) (*github.Milestone, error)

func FetchOwnerAndRepoFromURL

func FetchOwnerAndRepoFromURL(url *url.URL) (*string, *string, error)

func GetMilestone

func GetMilestone(ctx context.Context, repo ghrepo.Interface, number int) (*github.Milestone, error)

func GetMilestoneByURL

func GetMilestoneByURL(ctx context.Context, url *url.URL) (*github.Milestone, error)

func Milestones

func Milestones(ctx context.Context, repo ghrepo.Interface, filterOpts FilterOptions) ([]*github.Milestone, error)

func ReopenMilestone

func ReopenMilestone(ctx context.Context, opts ReopenMilestoneOptions) (*github.Milestone, error)

func WithBaseURL

func WithBaseURL(baseURL string) clientOption

func WithToken

func WithToken(token string) clientOption

Types

type CloseMilestoneOptions

type CloseMilestoneOptions struct {
	IO        *iostreams.IOStreams
	Repo      ghrepo.Interface
	Milestone *github.Milestone
}

type CreateMilestoneOptions

type CreateMilestoneOptions struct {
	IO    *iostreams.IOStreams
	Repo  ghrepo.Interface
	State *iMilestone.MilestoneMetadataState
}

type FilterOptions

type FilterOptions struct {
	Author     string
	BaseBranch string
	Fields     []string
	Repo       string
	Search     string
	State      string
}

type ReopenMilestoneOptions

type ReopenMilestoneOptions struct {
	IO        *iostreams.IOStreams
	Repo      ghrepo.Interface
	Milestone *github.Milestone
}