Skip to main content

Github Repository Template

GithubRepositoryTemplate​

Reusable template for new GitHub repositories.

A GithubRepository references it by name and uses only the resolved template name. The template provisions no GitHub resource itself.

PropertyTypeDescription
apiVersionstringAPI schema version. Must be lowops.manifests.v1.
kindstringResource kind. Must be GithubRepositoryTemplate.
metadatamapThe engine reads the reserved keys name and organization to resolve the identity of the manifest and its parent GithubConnection and Organization.
specSpecTemplate definition. See Spec.

Spec​

User-provided template definition.

Baseline settings for repositories that derive from this template.

PropertyTypeDescription
publicboolNOT YET IMPLEMENTED. The engine ignores this field. Intended use: true makes derived repositories public, otherwise they are private.
descriptionstringOptional description. It is documentation only: the engine does not copy it to any GitHub resource.
namestringName of the template repository on GitHub. The engine uses it as is and adds no prefix. Default: metadata.name.
strategystringNOT YET IMPLEMENTED. The engine ignores this field. One of GIT_FLOW, GITHUB_FLOW or TRUNK_BASED. Intended use: branch protection rules on derived repositories. A GithubRepository fully applies its own strategy field.
codeOwnerslist of CodeOwnersEntryNOT YET IMPLEMENTED. The engine ignores this field. Map of path pattern to owners, intended for the .github/CODEOWNERS file. The permissions field drives code-owner aggregation instead.
pullRequestPullRequestConfigGithubPullRequestTemplate to use for derived repositories. See PullRequestConfig.
licensestringName of the GithubLicense manifest to use. The engine validates it and resolves its content into computed.license.
permissionsAccessPermissionsUsers and groups with admin, write or read access. The engine does not apply them as repository permissions. The admin and contributor groups and members feed the code-owner set of the parent Organization.

CodeOwnerEntry​

Code owners for a repository path.

Entry of the code_owners map, keyed by path pattern. Intended for a .github/CODEOWNERS file.

PropertyTypeDescription
ownerslist of stringGitHub team names or user handles that own the path.

CodeOwnersEntry​

PropertyTypeDescription
keystring
valueCodeOwnerEntry

PullRequestConfig​

Pull request template reference.

Selects the GithubPullRequestTemplate whose content seeds the pull request template of a derived repository.

PropertyTypeDescription
templatestringName of the GithubPullRequestTemplate manifest to use. It must exist under the same connection.

AccessPermissions​

Administrator, contributor, and viewer privileges for an asset.

The engine aggregates the users and groups into IAM policies.

PropertyTypeDescription
administratorsDetailedAccessPermissionsUsers and groups with administrative privileges, usually full control.
contributorsDetailedAccessPermissionsUsers and groups with contributor privileges, usually read and write access.
viewersDetailedAccessPermissionsUsers and groups with viewer privileges, usually read-only access.

DetailedAccessPermissions​

User and group access definitions.

The engine resolves the listed manifests to Google Workspace identity emails for IAM bindings.

PropertyTypeDescription
memberslist of stringNames of OrganizationUser manifests.
groupslist of stringNames of OrganizationUserGroup manifests.