github_issue

Documentation

Index

• func OpenIssue(ghToken, title, description string, isFeatureRequest bool) (string, error)
• type RateError
  • func (e RateError) Error() string
  • func (e *RateError) Unwrap() error

Functions

func OpenIssue

func OpenIssue(ghToken, title, description string, isFeatureRequest bool) (string, error)

OpenIssue

@brief:

OpenIssue open an issue on in Terrap's repository

@params:

ghToken - string - the GitHub token to use
title - string - the issue title
description - string - the problem / feature request title
isFeatureRequest - bool - is a feature request

@returns:

string - the new issue number
error - if exists

Types

type RateError

type RateError struct {
	// contains filtered or unexported fields
}

RateError represents a case where the amount of GitHub url calls allowed per hour was exceeded

func (RateError) Error

func (e RateError) Error() string

Error

@brief:

Error implementation of the error interface

@returns:

string - the error itself

func (*RateError) Unwrap

func (e *RateError) Unwrap() error

Unwrap

@brief:

Unwrap returns the wrapped error, if any.

@returns:

error