IssueReporter.jl Documentation

IssueReporter.jl Documentation

Functions

packageuri(pkgname)

Takes the name of a registered Julia package and returns the associated repo git URL.

Examples

julia> IssueReporter.packageuri("IssueReporter")
"git://github.com/essenciary/IssueReporter.jl.git"
tokenisdefined()

Checks if the required GitHub authentication token is defined.

token()

Returns the configured GitHub authentication token, if defined – or throws an error otherwise.

githubauth()

Performs GitHub authentication and returns the OAuth2 object, required by further GitHub API calls.

repoid(package_name)

Converts a registered Julia package name to the corresponding GitHub "username/repo_name" string.

Examples

julia> IssueReporter.repoid("IssueReporter")
"essenciary/IssueReporter.jl"
report(package_name, title, body)

Creates a new GitHub issue with the title title and the content body onto the repo corresponding to the registered package called pack-age_name.

Index