{"id":27880849,"url":"https://github.com/atomicgo/ghissue","last_synced_at":"2025-05-05T04:38:33.682Z","repository":{"id":44087003,"uuid":"508283116","full_name":"atomicgo/ghissue","owner":"atomicgo","description":"📦 Go library that enables your users to submit error reports to GitHub","archived":false,"fork":false,"pushed_at":"2024-08-08T17:04:19.000Z","size":4806,"stargazers_count":13,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-14T15:05:23.701Z","etag":null,"topics":["atomicgo","feedback","github","go","golang","golang-library","issues"],"latest_commit_sha":null,"homepage":"https://atomicgo.dev","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/atomicgo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["MarvinJWendt"]}},"created_at":"2022-06-28T12:08:22.000Z","updated_at":"2024-08-08T17:04:22.000Z","dependencies_parsed_at":"2024-06-20T11:54:18.259Z","dependency_job_id":"745814cb-8b69-41c6-86f7-6b0dcc782e7c","html_url":"https://github.com/atomicgo/ghissue","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":"atomicgo/template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atomicgo%2Fghissue","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atomicgo%2Fghissue/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atomicgo%2Fghissue/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atomicgo%2Fghissue/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/atomicgo","download_url":"https://codeload.github.com/atomicgo/ghissue/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252442480,"owners_count":21748448,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["atomicgo","feedback","github","go","golang","golang-library","issues"],"created_at":"2025-05-05T04:38:32.959Z","updated_at":"2025-05-05T04:38:33.666Z","avatar_url":"https://github.com/atomicgo.png","language":"Go","readme":"\u003ch1 align=\"center\"\u003eAtomicGo | ghissue\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"https://img.shields.io/endpoint?url=https%3A%2F%2Fatomicgo.dev%2Fapi%2Fshields%2Fghissue\u0026style=flat-square\" alt=\"Downloads\"\u003e\n\n\u003ca href=\"https://github.com/atomicgo/ghissue/releases\"\u003e\n\u003cimg src=\"https://img.shields.io/github/v/release/atomicgo/ghissue?style=flat-square\" alt=\"Latest Release\"\u003e\n\u003c/a\u003e\n\n\u003ca href=\"https://codecov.io/gh/atomicgo/ghissue\" target=\"_blank\"\u003e\n\u003cimg src=\"https://img.shields.io/github/actions/workflow/status/atomicgo/ghissue/go.yml?style=flat-square\" alt=\"Tests\"\u003e\n\u003c/a\u003e\n\n\u003ca href=\"https://codecov.io/gh/atomicgo/ghissue\" target=\"_blank\"\u003e\n\u003cimg src=\"https://img.shields.io/codecov/c/gh/atomicgo/ghissue?color=magenta\u0026logo=codecov\u0026style=flat-square\" alt=\"Coverage\"\u003e\n\u003c/a\u003e\n\n\u003ca href=\"https://codecov.io/gh/atomicgo/ghissue\"\u003e\n\u003c!-- unittestcount:start --\u003e\u003cimg src=\"https://img.shields.io/badge/Unit_Tests-0-magenta?style=flat-square\" alt=\"Unit test count\"\u003e\u003c!-- unittestcount:end --\u003e\n\u003c/a\u003e\n\n\u003ca href=\"https://opensource.org/licenses/MIT\" target=\"_blank\"\u003e\n\u003cimg src=\"https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square\" alt=\"License: MIT\"\u003e\n\u003c/a\u003e\n  \n\u003ca href=\"https://goreportcard.com/report/github.com/atomicgo/ghissue\" target=\"_blank\"\u003e\n\u003cimg src=\"https://goreportcard.com/badge/github.com/atomicgo/ghissue?style=flat-square\" alt=\"Go report\"\u003e\n\u003c/a\u003e   \n\n\u003c/p\u003e\n\n---\n\n\u003cp align=\"center\"\u003e\n\u003cstrong\u003e\u003ca href=\"https://pkg.go.dev/atomicgo.dev/ghissue#section-documentation\" target=\"_blank\"\u003eDocumentation\u003c/a\u003e\u003c/strong\u003e\n|\n\u003cstrong\u003e\u003ca href=\"https://github.com/atomicgo/atomicgo/blob/main/CONTRIBUTING.md\" target=\"_blank\"\u003eContributing\u003c/a\u003e\u003c/strong\u003e\n|\n\u003cstrong\u003e\u003ca href=\"https://github.com/atomicgo/atomicgo/blob/main/CODE_OF_CONDUCT.md\" target=\"_blank\"\u003eCode of Conduct\u003c/a\u003e\u003c/strong\u003e\n\u003c/p\u003e\n\n---\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/atomicgo/atomicgo/main/assets/header.png\" alt=\"AtomicGo\"\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\u003ctable\u003e\n\u003ctbody\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003c/p\u003e\n\u003ch3  align=\"center\"\u003e\u003cpre\u003ego get atomicgo.dev/ghissue\u003c/pre\u003e\u003c/h3\u003e\n\u003cp align=\"center\"\u003e\n\u003ctable\u003e\n\u003ctbody\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003c/p\u003e\n\n\u003c!-- gomarkdoc:embed:start --\u003e\n\n\u003c!-- Code generated by gomarkdoc. DO NOT EDIT --\u003e\n\n# ghissue\n\n```go\nimport \"atomicgo.dev/ghissue\"\n```\n\nPackage ghissue enables your users to submit issues to GitHub directly.\n\n\\!\\[Demo Video\\]\\(https://raw.githubusercontent.com/atomicgo/ghissue/main/demo.gif\\)\n\nExample:\n\n```\nrepo := ghissue.NewRepository(\"atomicgo\", \"ghissue\")\n// [...]\nerr := errors.New(\"This is an error\")\nrepo.CreateErrorReport(err) // Only creates an error report if the error is not nil\n```\n\n## Index\n\n- [Variables](\u003c#variables\u003e)\n- [type Issue](\u003c#Issue\u003e)\n  - [func NewIssue\\(repo Repository, title, body string\\) Issue](\u003c#NewIssue\u003e)\n  - [func \\(issue Issue\\) GetCreateURL\\(\\) string](\u003c#Issue.GetCreateURL\u003e)\n  - [func \\(issue Issue\\) Open\\(\\) error](\u003c#Issue.Open\u003e)\n- [type Repository](\u003c#Repository\u003e)\n  - [func NewRepository\\(owner, name string\\) Repository](\u003c#NewRepository\u003e)\n  - [func \\(repo Repository\\) CreateErrorReport\\(err error\\) error](\u003c#Repository.CreateErrorReport\u003e)\n  - [func \\(repo Repository\\) NewIssue\\(title, body string\\) Issue](\u003c#Repository.NewIssue\u003e)\n  - [func \\(repo Repository\\) String\\(\\) string](\u003c#Repository.String\u003e)\n\n\n## Variables\n\n\u003ca name=\"ErrOpenBrowser\"\u003e\u003c/a\u003eErrOpenBrowser is the error returned when opening the browser fails.\n\n```go\nvar ErrOpenBrowser = errors.New(\"failed to open browser\")\n```\n\n\u003ca name=\"Issue\"\u003e\u003c/a\u003e\n## type [Issue](\u003chttps://github.com/atomicgo/ghissue/blob/main/issue.go#L11-L15\u003e)\n\nIssue is a GitHub issue.\n\n```go\ntype Issue struct {\n    Repository Repository\n    Title      string\n    Body       string\n}\n```\n\n\u003ca name=\"NewIssue\"\u003e\u003c/a\u003e\n### func [NewIssue](\u003chttps://github.com/atomicgo/ghissue/blob/main/issue.go#L18\u003e)\n\n```go\nfunc NewIssue(repo Repository, title, body string) Issue\n```\n\nNewIssue creates a new issue.\n\n\u003ca name=\"Issue.GetCreateURL\"\u003e\u003c/a\u003e\n### func \\(Issue\\) [GetCreateURL](\u003chttps://github.com/atomicgo/ghissue/blob/main/issue.go#L27\u003e)\n\n```go\nfunc (issue Issue) GetCreateURL() string\n```\n\nGetCreateURL returns the URL to create an issue.\n\n\u003ca name=\"Issue.Open\"\u003e\u003c/a\u003e\n### func \\(Issue\\) [Open](\u003chttps://github.com/atomicgo/ghissue/blob/main/issue.go#L32\u003e)\n\n```go\nfunc (issue Issue) Open() error\n```\n\nOpen opens the \"create issue\" menu on GitHub in the browser.\n\n\u003ca name=\"Repository\"\u003e\u003c/a\u003e\n## type [Repository](\u003chttps://github.com/atomicgo/ghissue/blob/main/repository.go#L10-L13\u003e)\n\nRepository is a GitHub repository.\n\n```go\ntype Repository struct {\n    Owner string\n    Name  string\n}\n```\n\n\u003ca name=\"NewRepository\"\u003e\u003c/a\u003e\n### func [NewRepository](\u003chttps://github.com/atomicgo/ghissue/blob/main/repository.go#L16\u003e)\n\n```go\nfunc NewRepository(owner, name string) Repository\n```\n\nNewRepository creates a new Repository from an owner and repository name.\n\n\u003ca name=\"Repository.CreateErrorReport\"\u003e\u003c/a\u003e\n### func \\(Repository\\) [CreateErrorReport](\u003chttps://github.com/atomicgo/ghissue/blob/main/repository.go#L41\u003e)\n\n```go\nfunc (repo Repository) CreateErrorReport(err error) error\n```\n\nCreateErrorReport creates a new issue on GitHub with a detailed error report including the stack trace.\n\nExample:\n\n```\nrepo := ghissue.NewRepository(\"atomicgo\", \"ghissue\")\n     // [...]\n     err := errors.New(\"This is an error\")\n\t\trepo.CreateErrorReport(err)\n```\n\n\u003ca name=\"Repository.NewIssue\"\u003e\u003c/a\u003e\n### func \\(Repository\\) [NewIssue](\u003chttps://github.com/atomicgo/ghissue/blob/main/repository.go#L29\u003e)\n\n```go\nfunc (repo Repository) NewIssue(title, body string) Issue\n```\n\nNewIssue creates a new issue with a title and body.\n\n\u003ca name=\"Repository.String\"\u003e\u003c/a\u003e\n### func \\(Repository\\) [String](\u003chttps://github.com/atomicgo/ghissue/blob/main/repository.go#L24\u003e)\n\n```go\nfunc (repo Repository) String() string\n```\n\nString returns the string representation of the repository.\n\nGenerated by [gomarkdoc](\u003chttps://github.com/princjef/gomarkdoc\u003e)\n\n\n\u003c!-- gomarkdoc:embed:end --\u003e\n\n---\n\n\u003e [AtomicGo.dev](https://atomicgo.dev) \u0026nbsp;\u0026middot;\u0026nbsp;\n\u003e with ❤️ by [@MarvinJWendt](https://github.com/MarvinJWendt) |\n\u003e [MarvinJWendt.com](https://marvinjwendt.com)\n","funding_links":["https://github.com/sponsors/MarvinJWendt"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatomicgo%2Fghissue","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fatomicgo%2Fghissue","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatomicgo%2Fghissue/lists"}