GitHubRepositoryCoordinates

data class GitHubRepositoryCoordinates(val owner: String, val repository: String, val ref: String = DEFAULT_REF)

Location of a GitHub repository at a given ref, and the URLs needed to read parts of it anonymously. Path components are percent-encoded, so file names with spaces or reserved characters resolve correctly.

Parameters

owner

user or organization that owns the repository

repository

repository name

ref

branch, tag or commit to read from

Constructors

Link copied to clipboard
constructor(owner: String, repository: String, ref: String = DEFAULT_REF)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
Link copied to clipboard
val ref: String
Link copied to clipboard

Functions

Link copied to clipboard
fun rawFileUrl(path: String): Url
Link copied to clipboard
fun subtreeUrl(path: String): Url
Link copied to clipboard
fun treeUrl(): Url