Zum Hauptinhalt springen

GitHubBlueprintCatalogOptions

Namespace: Meshmakers.Octo.ConstructionKit.Contracts.BlueprintCatalogs

Defines the GitHub Options for GitHub blueprint catalog

public abstract class GitHubBlueprintCatalogOptions : BlueprintCatalogOptions, IGitHubOptions

Inheritance Object → BlueprintCatalogOptions → GitHubBlueprintCatalogOptions
Implements IGitHubOptions

Properties​

IsEnabled​

When false, the catalog is neither read nor written: it contributes nothing to listings, dependency resolution or installs, and a refresh reports it as skipped (AB#6112). Mirrors GitHubCatalogOptions.IsEnabled on the CK side; bound from the same configuration sections as the repository coordinates (e.g. PrivateOctoGitHubBlueprints:IsEnabled).

public bool IsEnabled { get; set; }

Property Value​

Boolean

Remarks:

Defaults to true, which is the behaviour every installation had before the switch existed: a host that does not set it keeps reading both GitHub blueprint catalogs. Production installations opt out of the private (main-lane) catalog explicitly via configuration.

GitHubApiToken​

API Token for GitHub (optional - only needed for write operations)

public string GitHubApiToken { get; set; }

Property Value​

String

GitHubRepositoryName​

Name of the GitHub repository

public string GitHubRepositoryName { get; set; }

Property Value​

String

GitHubRepositoryOwner​

Owner of the GitHub repository

public string GitHubRepositoryOwner { get; set; }

Property Value​

String

GitHubRepositoryBranch​

GitHub repository branch

public string GitHubRepositoryBranch { get; set; }

Property Value​

String

GitHubPagesUri​

The uri to the GitHub pages site where the blueprints are stored.

public string GitHubPagesUri { get; set; }

Property Value​

String

ProductName​

Represents the product name to be used in the User-Agent header when making requests to GitHub API.

public string ProductName { get; set; }

Property Value​

String

CacheFileName​

Gets or sets the cache file name for the blueprint catalog

public string CacheFileName { get; set; }

Property Value​

String

CacheDirectory​

Gets or sets the cache directory for blueprint catalogs

public string CacheDirectory { get; set; }

Property Value​

String