core-utils/com.pambrose.common.util/GitHubRepo

GitHubRepo

class GitHubRepo(ownerType: OwnerType, ownerName: String, repoName: String, scheme: String = "https://", domainName: String = GITHUB) : AbstractRepo

A ContentRoot representing a GitHub repository.

Raw content for github.com is fetched from raw.githubusercontent.com. For any other domain (GitHub Enterprise Server) it is fetched from the HOSTNAME/raw/ path, the form used when subdomain isolation is disabled; a server with subdomain isolation enabled serves raw content from raw.HOSTNAME instead, which this class does not detect.

Parameters

ownerType

whether the owner is a user or organization

ownerName

the GitHub username or organization name

repoName

the repository name

scheme

the URL scheme, defaults to "https://"

domainName

the GitHub domain, defaults to "github.com"

Constructors

constructor(ownerType: OwnerType, ownerName: String, repoName: String, scheme: String = "https://", domainName: String = GITHUB)

Properties

val domainName: String

val ownerName: String

val ownerType: OwnerType

rawSourcePrefix

open override val rawSourcePrefix: String

The URL prefix used to access raw file content from this repository.

open override val remote: Boolean = true

Whether this root points to a remote location.

val repoName: String

val scheme: String

open override val sourcePrefix: String

The prefix path or URL used to resolve files within this root.

Functions

open override fun file(path: String): UrlSource

Creates a ContentSource for path within this root.

fun file(path: String, connectTimeout: Duration, readTimeout: Duration): UrlSource

Creates a UrlSource for path, as file does, with the given timeouts.

open override fun toString(): String