auth

Documentation

Overview

Package auth provides helper methods for generating clients for the GitHub API.

This includes building authentication into the generated client (when applicable).

Note that we don't provide username/password authentication; It's both insecure and more complex to implement.

Index

• Constants
• func TokenClient(token string) *github.Client
• func UnauthenticatedClient() *github.Client

Constants

const (
	// TokenHelp is a human-friendly string that can be used to describe token requirements in usage messages.
	TokenHelp = `` /* 190-byte string literal not displayed */

)

Functions

func TokenClient

func TokenClient(token string) *github.Client

TokenClient takes an oauth token and returns an authenticated github client. The client is guaranteed to work.

func UnauthenticatedClient

func UnauthenticatedClient() *github.Client

UnauthenticatedClient builds a github client that uses http.Client's default HTTP transport. The client will be insecure and extremely rate-limited; non-authenticated users are limited to 60 requests / hour.