repository

Documentation

Overview

Package repository is a set of types and functions for modeling and interacting with GitHub repositories.

Index

• type Repository
  • func Parse(s string) (Repository, error)
  • func ParseWithHost(s, host string) (Repository, error)

Types

type Repository

type Repository interface {
	Host() string
	Name() string
	Owner() string
}

Repository is the interface that wraps repository information methods.

func Parse

func Parse(s string) (Repository, error)

Parse extracts the repository information from the following string formats: "OWNER/REPO", "HOST/OWNER/REPO", and a full URL. If the format does not specify a host, use the config to determine a host.

func ParseWithHost

func ParseWithHost(s, host string) (Repository, error)

Parse extracts the repository information from the following string formats: "OWNER/REPO", "HOST/OWNER/REPO", and a full URL. If the format does not specify a host, use the host provided.