gh

README

gh

GitHub API helpers for various FerretDB projects.

Documentation

Overview

Package gh provides GitHub API helpers used by many FerretDB repos.

Index

• func NewRESTClient(token string, debugf Printf) (*github.Client, error)
• func NewTransport(source http.RoundTripper, debugf Printf) http.RoundTripper
• func NoopPrintf(string, ...any)
• type Printf
  • func SLogPrintf(l *slog.Logger) Printf

Functions

func NewRESTClient

func NewRESTClient(token string, debugf Printf) (*github.Client, error)

NewRESTClient returns GitHub REST API client for the given token (that may be empty) and debug logging function (that may be nil).

func NewTransport

func NewTransport(source http.RoundTripper, debugf Printf) http.RoundTripper

NewTransport returns a new http.RoundTripper that wraps the source with debug logging. Both should be set.

func NoopPrintf

func NoopPrintf(string, ...any)

NoopPrintf is a Printf function that does nothing.

Types

type Printf

type Printf func(format string, args ...any)

Printf is a (fmt.Printf|log.Printf|testing.T.Logf)-like function.

func SLogPrintf

func SLogPrintf(l *slog.Logger) Printf

SLogPrintf is a Printf function that uses given slog.Logger with Debug level.