Skip to content

git_repository_file.html.markdown

Latest commit

 

History

History
147 lines (104 loc) · 4.39 KB

git_repository_file.html.markdown

File metadata and controls

147 lines (104 loc) · 4.39 KB
Error in user YAML: (<unknown>): did not find expected comment or line break while scanning a block scalar at line 3 column 14
---
layout: "azuredevops"
page_title: "AzureDevops: azuredevops_git_repository_file"
description: |- Manage files within an Azure DevOps Git repository.
---

azuredevops_git_repository_file

Manage files within an Azure DevOps Git repository.

Example Usage

resource "azuredevops_project" "example" {
  name               = "Example Project"
  visibility         = "private"
  version_control    = "Git"
  work_item_template = "Agile"
}

resource "azuredevops_git_repository" "example" {
  project_id = azuredevops_project.example.id
  name       = "Example Git Repository"
  initialization {
    init_type = "Clean"
  }
}

resource "azuredevops_git_repository_file" "example" {
  repository_id       = azuredevops_git_repository.example.id
  file                = ".gitignore"
  content             = "**/*.tfstate"
  branch              = "refs/heads/master"
  commit_message      = "First commit"
  overwrite_on_create = false
}

Author Email Pattern

resource "azuredevops_project" "example" {
  name               = "Example Project"
  visibility         = "private"
  version_control    = "Git"
  work_item_template = "Agile"
}

resource "azuredevops_git_repository" "example" {
  project_id = azuredevops_project.example.id
  name       = "Example Git Repository"
  initialization {
    init_type = "Clean"
  }
}

resource "azuredevops_repository_policy_author_email_pattern" "example" {
  project_id            = azuredevops_project.example.id
  enabled               = true
  blocking              = true
  author_email_patterns = ["auhtor@test.com"]
  repository_ids        = [azuredevops_git_repository.example.id]
}


resource "azuredevops_git_repository_file" "example" {
  repository_id       = azuredevops_git_repository.example.id
  file                = ".gitignore"
  content             = "**/*.tfstate"
  branch              = "refs/heads/master"
  commit_message      = "First commit"
  overwrite_on_create = false
  author_name         = "authorname"
  author_email        = "auhtor@test.com"
  depends_on          = [azuredevops_repository_policy_author_email_pattern.example]
}

Argument Reference

The following arguments are supported:

  • repository_id - (Required) The ID of the Git repository.

  • file - (Required) The path of the file to manage.

  • content - (Required) The file content.

  • branch - (Optional) Git branch (defaults to refs/heads/master). The branch must already exist, it will not be created if it does not already exist.

  • commit_message - (Optional) Commit message when adding or updating the managed file.

  • overwrite_on_create - (Optional) Enable overwriting existing files (defaults to false).

  • author_name - (Optional) The name of the author.

  • author_email - (Optional) The email of the author.

  • committer_name - (Optional) The name of the committer.

  • committer_email - (Optional) The email of the committer.

Attributes Reference

The following attributes are exported:

  • id - The ID of the git repository file in format of repository ID/file

  • project_id - The ID of the Project.

  • commit_message - Commit message when adding or updating the managed file.

  • author_name - The name of the author.

  • author_email - The email of the author.

  • committer_name - The name of the committer.

  • committer_email - The email of the committer.

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • create - (Defaults to 10 minutes) Used when creating the Git Repository File.
  • read - (Defaults to 5 minute) Used when retrieving the Git Repository File.
  • update - (Defaults to 10 minutes) Used when updating the Git Repository File.
  • delete - (Defaults to 10 minutes) Used when deleting the Git Repository File.

Import

Repository files can be imported using a combination of the repository ID and file, e.g.

terraform import azuredevops_git_repository_file.example 00000000-0000-0000-0000-000000000000/.gitignore

To import a file from a branch other than master, append : and the branch name, e.g.

terraform import azuredevops_git_repository_file.example 00000000-0000-0000-0000-000000000000/.gitignore:refs/heads/master

Relevant Links