monitor

Documentation

Overview

Package monitor provides a command-line application to query the GitHub API for API rate limits and deliver a notification message if the number of remaining API calls is <= (n).

Index

• func DefaultFlagSet() *flag.FlagSet
• func Run(ctx context.Context, logger *log.Logger) error
• func RunWithFlagSet(ctx context.Context, fs *flag.FlagSet, logger *log.Logger) error

Functions

func DefaultFlagSet

func DefaultFlagSet() *flag.FlagSet

DefaultFlagSet returns a default `flag.FlagSet` instance configured with the necessary flags to execute the command-line application to query the GitHub API for API rate limits.

func Run

func Run(ctx context.Context, logger *log.Logger) error

Run executes the command-line application to query the GitHub API for API rate limits using the default `flag.FlagSet` instance.

func RunWithFlagSet

func RunWithFlagSet(ctx context.Context, fs *flag.FlagSet, logger *log.Logger) error

Run executes the command-line application to query the GitHub API for API rate limits using a custom `flag.FlagSet` instance.