AtomicGo | ghissue

Get The Module | Documentation | Contributing | Code of Conduct

-----------------------------------------------------------------------------------------------------

go get atomicgo.dev/ghissue

-----------------------------------------------------------------------------------------------------

Description

Package ghissue enables your users to submit issues to GitHub directly.

Example:

repo := ghissue.NewRepository("atomicgo", "ghissue")
// [...]
err := errors.New("This is an error")
repo.CreateErrorReport(err) // Only creates an error report if the error is not nil

Usage

var ErrOpenBrowser = errors.New("failed to open browser")

ErrOpenBrowser is the error returned when opening the browser fails.

type Issue

type Issue struct {
	Repository Repository
	Title      string
	Body       string
}

Issue is a GitHub issue.

func NewIssue

func NewIssue(repo Repository, title, body string) Issue

NewIssue creates a new issue.

func (Issue) GetCreateURL

func (issue Issue) GetCreateURL() string

GetCreateURL returns the URL to create an issue.

func (Issue) Open

func (issue Issue) Open() error

Open opens the "create issue" menu on GitHub in the browser.

type Repository

type Repository struct {
	Owner string
	Name  string
}

Repository is a GitHub repository.

func NewRepository

func NewRepository(owner, name string) Repository

NewRepository creates a new Repository from an owner and repository name.

func (Repository) CreateErrorReport

func (repo Repository) CreateErrorReport(err error) error

CreateErrorReport creates a new issue on GitHub with a detailed error report including the stack trace.

Example:

		repo := ghissue.NewRepository("atomicgo", "ghissue")
     // [...]
     err := errors.New("This is an error")
		repo.CreateErrorReport(err)

func (Repository) NewIssue

func (repo Repository) NewIssue(title, body string) Issue

NewIssue creates a new issue with a title and body.

func (Repository) String

func (repo Repository) String() string

String returns the string representation of the repository.

AtomicGo.dev  ·  with ❤️ by @MarvinJWendt | MarvinJWendt.com