Skip to content

Latest commit

 

History

History
82 lines (47 loc) · 2.52 KB

repository.html.markdown

File metadata and controls

82 lines (47 loc) · 2.52 KB
Raw
layout page_title description
github
GitHub: github_repository
Get details about GitHub repository

github_repository

Use this data source to retrieve information about a GitHub repository.

Example Usage

data "github_repository" "example" {
  full_name = "hashicorp/terraform"
}

Argument Reference

The following arguments are supported:

  • name - (Optional) The name of the repository.

  • full_name - (Optional) Full name of the repository (in org/name format).

Attributes Reference

  • node_id - the Node ID of the repository.

  • description - A description of the repository.

  • homepage_url - URL of a page describing the project.

  • private - Whether the repository is private.

  • visibility - Whether the repository is public, private or internal.

  • has_issues - Whether the repository has GitHub Issues enabled.

  • has_projects - Whether the repository has the GitHub Projects enabled.

  • has_wiki - Whether the repository has the GitHub Wiki enabled.

  • allow_merge_commit - Whether the repository allows merge commits.

  • allow_squash_merge - Whether the repository allows squash merges.

  • allow_rebase_merge - Whether the repository allows rebase merges.

  • allow_auto_merge - Whether the repository allows auto-merging pull requests.

  • allow_update_branch - Whether the repository allows users to be prompted to update their branches if there are new changes available in the base branch..

  • has_downloads - Whether the repository has Downloads feature enabled.

  • default_branch - The name of the default branch of the repository.

  • archived - Whether the repository is archived.

  • pages - The repository's GitHub Pages configuration.

  • topics - The list of topics of the repository.

  • html_url - URL to the repository on the web.

  • ssh_clone_url - URL that can be provided to git clone to clone the repository via SSH.

  • http_clone_url - URL that can be provided to git clone to clone the repository via HTTPS.

  • git_clone_url - URL that can be provided to git clone to clone the repository anonymously via the git protocol.

  • svn_url - URL that can be provided to svn checkout to check out the repository via GitHub's Subversion protocol emulation.

  • node_id - GraphQL global node id for use with v4 API

  • repo_id - GitHub ID for the repository

  • branches - The list of this repository's branches. Each element of branches has the following attributes:

  • name - Name of the branch.

  • protected - Whether the branch is protected.