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

GitHubFile

open class GitHubFile(val repo: GitHubRepo, val branchName: String, val srcPath: String, val fileName: String) : UrlSource

A ContentSource pointing to a specific file in a GitHub repository.

Constructs the raw content URL from the repository, branch, path, and file name.

Parameters

repo

the GitHub repository

branchName

the branch or tag name

srcPath

the directory path within the repository

fileName

the file name

Constructors

constructor(repo: GitHubRepo, branchName: String, srcPath: String, fileName: String)

Properties

val branchName: String

open override val content: String

The textual content read from this source.

val fileName: String

open override val remote: Boolean = true

Whether this source is remote (URL-based).

val repo: GitHubRepo

open override val source: String

val srcPath: String

Functions

open override fun toString(): String