github

Documentation

Index

• Constants
• func CreateRelease(token string, repo string, tag string, name string) error
• func DoAuthRequest(method, url, bodyType, token string, headers map[string]string, body io.Reader) (*http.Response, error)
• func Download(token string, url string, name string) error
• func DownloadAsset(token string, repo string, tag string, name string) error
• func DownloadSource(token string, repo string, tag string) error
• func Get(url string, v interface{}) error
• func GetFileSize(f *os.File) (int64, error)
• func NewAuthRequest(method, url, bodyType, token string, headers map[string]string, body io.Reader) (*http.Request, error)
• func Upload(token string, repo string, tag string, name string, file string) error
• type Asset
• type ErrNotFound
  • func (e ErrNotFound) Error() string
• type Release
  • func LatestRelease(user, repo, token string) (release *Release, err error)
  • func ReleaseOfTag(user, repo, tag, token string) (*Release, error)
  • func Releases(user, repo, token string) (releases []Release, err error)
  • func (r *Release) CleanUploadURL() string
• type ReleaseCreate
• type Tag
  • func LatestTag(user, repo, token string) (tag *Tag, err error)
  • func Tags(user, repo, token string) (tags []Tag, err error)

Constants

const (
	ReleaseListPath   = "/repos/%s/%s/releases"
	ReleaseLatestPath = "/repos/%s/%s/releases/latest"
)

const (
	AssetDownloadURI = "/repos/%s/%s/releases/assets/%d"
)

const (
	GithubAPIURL = "https://api.github.com"
)

const (
	TagListPath = "/repos/%s/%s/tags"
)

Functions

func CreateRelease

func CreateRelease(token string, repo string, tag string, name string) error

func DoAuthRequest

func DoAuthRequest(method, url, bodyType, token string, headers map[string]string, body io.Reader) (*http.Response, error)

func Download

func Download(token string, url string, name string) error

func DownloadAsset

func DownloadAsset(token string, repo string, tag string, name string) error

func DownloadSource

func DownloadSource(token string, repo string, tag string) error

func Get

func Get(url string, v interface{}) error

func GetFileSize

func GetFileSize(f *os.File) (int64, error)

func NewAuthRequest

func NewAuthRequest(method, url, bodyType, token string, headers map[string]string, body io.Reader) (*http.Request, error)

NewAuthRequest creates a new request that sends the auth token

func Upload

func Upload(token string, repo string, tag string, name string, file string) error

Types

type Asset

type Asset struct {
	URL                string    `json:"url"`
	ID                 int       `json:"id"`
	Name               string    `json:"name"`
	ContentType        string    `json:"content_type"`
	State              string    `json:"state"`
	Size               uint64    `json:"size"`
	Downloads          uint64    `json:"download_count"`
	Created            time.Time `json:"created_at"`
	Published          time.Time `json:"published_at"`
	BrowserDownloadURL string    `json:"browser_download_url"`
}

type ErrNotFound

type ErrNotFound struct {
	Name  string
	Key   string
	Value string
}

func (ErrNotFound) Error

func (e ErrNotFound) Error() string

type Release

type Release struct {
	URL         string     `json:"url"`
	PageURL     string     `json:"html_url"`
	UploadURL   string     `json:"upload_url"`
	ID          int        `json:"id"`
	Name        string     `json:"name"`
	Description string     `json:"body"`
	TagName     string     `json:"tag_name"`
	Draft       bool       `json:"draft"`
	Prerelease  bool       `json:"prerelease"`
	Created     *time.Time `json:"created_at"`
	Published   *time.Time `json:"published_at"`
	Assets      []Asset    `json:"assets"`
}

func LatestRelease

func LatestRelease(user, repo, token string) (release *Release, err error)

func ReleaseOfTag

func ReleaseOfTag(user, repo, tag, token string) (*Release, error)

func Releases

func Releases(user, repo, token string) (releases []Release, err error)

func (*Release) CleanUploadURL

func (r *Release) CleanUploadURL() string

type ReleaseCreate

type ReleaseCreate struct {
	TagName         string `json:"tag_name"`
	TargetCommitish string `json:"target_commitish,omitempty"`
	Name            string `json:"name"`
	Body            string `json:"body"`
	Draft           bool   `json:"draft"`
	Prerelease      bool   `json:"prerelease"`
}

type Tag

type Tag struct {
	Name string `json:"name"`
}

func LatestTag

func LatestTag(user, repo, token string) (tag *Tag, err error)

func Tags

func Tags(user, repo, token string) (tags []Tag, err error)