GitHub

Hosted Git repositories with public, private and internal visibility and optional branch protection.

Provider: default
Kind: Artifact repository
Category: Data
Official docs: https://docs.github.com/en/repositories/creating-and-managing-repositories/about-repositories

Properties · 3 set by this component

property	type	values	required	kind default	this component
artifactType	enum	package \| source \| generic	yes	—	▸ source
branchProtection · component property	boolean	—	no	false	inherited
hostingModel · component property	enum	github-com \| enterprise-cloud \| enterprise-server	no	github-com	inherited
immutableVersions	boolean	—	no	—	inherited
managed	boolean	—	no	false	▸ true
retentionDays	integer	—	no	—	inherited
upstreamProxy	boolean	—	no	false	▸ false
visibility	enum	private \| public	no	—	inherited
visibilityLevel · component property	enum	public \| private \| internal	no	—	inherited
vulnerabilityScanning	boolean	—	no	—	inherited

Rules that apply · 0

Every rule whose selector covers this component's kind or its category. Whether a rule fires depends on the design: its properties, its edges and its groups.

No rule reads this kind yet. That is a gap, not a guarantee.

Use it in a design

nodes:
  - { id: "github", component: "github" }

Other Artifact repository products · 30

Source

1# yaml-language-server: $schema=../../schema/component.schema.json
2# GitHub: hosted Git source repositories. "About repositories" gives three visibility levels - public,
3# accessible to everyone on the internet, private, limited to people you share access with, and internal
4# for an enterprise account - and treats branch protection as rules an administrator adds afterwards.
5schemaVersion: "1"
6type: "component"
7id: "github"
8kind: "artifact-repository"
9provider: "default"
10docs: "https://docs.github.com/en/repositories/creating-and-managing-repositories/about-repositories"
11defaults:
12  artifactType: "source"
13  managed: true
14  upstreamProxy: false
15properties:
16  visibilityLevel:
17    type: "enum"
18    values: ["public", "private", "internal"]
19  hostingModel:
20    type: "enum"
21    values: ["github-com", "enterprise-cloud", "enterprise-server"]
22    default: "github-com"
23  branchProtection:
24    type: "boolean"
25    default: false

The same page as markdown, for an agent: /catalogue/components/github.md