client

Documentation

Overview

Package client provides helpers to initialize a GitHub client.

Index

• func CachingSingleton(url string) (*github.Client, error)
• func Singleton() (*github.Client, error)

Functions

func CachingSingleton

func CachingSingleton(url string) (*github.Client, error)

CachingSingleton similar to Singleton but with HTTP caching enabled.

Supported cache URLs:

• file:///path/to/cache/dir (disk cache)
• mem: (memory cache)

func Singleton

func Singleton() (*github.Client, error)

Singleton returns a GitHub client singleton.

A GitHub personal access token is required.

Singleton will try to read the token from the environment variable GITHUB_TOKEN or read it from the operating system keychain.

To add the token to the macOS keychain you can use the command line utility "security" like this:

security add-generic-password -a github -s GITHUB_TOKEN -w

To add the token to GNOME keyring use "secret-tool":

secret-tool store --label="GitHub Token" service GITHUB_TOKEN username github