README.md

AtomicGo | ghissue

---

Documentation | Contributing | Code of Conduct

---

go get atomicgo.dev/ghissue

ghissue

import "atomicgo.dev/ghissue"

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

Index

• Variables
• type Issue
  • func NewIssue(repo Repository, title, body string) Issue
  • func (issue Issue) GetCreateURL() string
  • func (issue Issue) Open() error
• type Repository
  • func NewRepository(owner, name string) Repository
  • func (repo Repository) CreateErrorReport(err error) error
  • func (repo Repository) NewIssue(title, body string) Issue
  • func (repo Repository) String() string

Variables

ErrOpenBrowser is the error returned when opening the browser fails.

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

type Issue

Issue is a GitHub issue.

type Issue struct {
    Repository Repository
    Title      string
    Body       string
}

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

Repository is a GitHub repository.

type Repository struct {
    Owner string
    Name  string
}

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.

Generated by gomarkdoc

---

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