Skip to content
Proud to collaborate with Microsoft for Startups

github.repos.get_repo ​

Get metadata for a single GitHub repository

Get metadata for a single GitHub repository.

Inputs:

  • owner: Repository owner (user or org) (required).
  • repo: Repository name (required).

Outputs (terminal state_data):

  • full_name: str — owner/repo
  • description: str | None
  • private: bool
  • default_branch: str
  • clone_url: str
  • stars: int
  • open_issues: int
  • url: str — HTML URL

Plugin required: context.get_plugin("github") must expose .token.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-github
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
ownerstringYes—Repository owner (user or org)
repostringYes—Repository name

Output Schema ​

FieldTypeRequiredDefaultDescription
clone_urlstringNo——
default_branchstringNo——
descriptionstringNo——
full_namestringNo——
open_issuesintegerNo——
privatebooleanNo——
starsintegerNo——
urlstringNo——
ownerstringNo——
repostringNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "github.repos.get_repo",
  "initial_data": {
    "owner": "value",
    "repo": "value"
  }
}