summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMike Vink <mike1994vink@gmail.com>2023-02-24 18:08:55 +0100
committerMike Vink <mike1994vink@gmail.com>2023-02-28 10:14:29 +0100
commita06e20fdd809343752b9f8ca819c7eaed32fe3d9 (patch)
tree4832be5a04538a05a38d29c137e3b5423c41a536
parent32cb7f4cdcdc08557dde388c89b08606f50a1929 (diff)
fix: update website
-rw-r--r--website/docs/r/git_repository_branch.html.markdown43
1 files changed, 14 insertions, 29 deletions
diff --git a/website/docs/r/git_repository_branch.html.markdown b/website/docs/r/git_repository_branch.html.markdown
index dbf51c59..e6cca74f 100644
--- a/website/docs/r/git_repository_branch.html.markdown
+++ b/website/docs/r/git_repository_branch.html.markdown
@@ -23,25 +23,20 @@ resource "azuredevops_git_repository" "example" {
project_id = azuredevops_project.example.id
name = "Example Git Repository"
initialization {
- init_type = "Uninitialized"
+ init_type = "Clean"
}
}
-resource "azuredevops_git_repository_branch" "example_orphan" {
+resource "azuredevops_git_repository_branch" "example" {
repository_id = azuredevops_git_repository.example.id
- name = "master"
+ name = "example-branch-name"
+ ref_branch = azuredevops_git_repository.example.default_branch
}
-resource "azuredevops_git_repository_branch" "example_from_ref" {
+resource "azuredevops_git_repository_branch" "example_from_commit_id" {
repository_id = azuredevops_git_repository.example.id
- name = "develop"
- source_ref = azuredevops_git_repository_branch.example_orphan.ref
-}
-
-resource "azuredevops_git_repository_branch" "example_from_sha" {
- repository_id = azuredevops_git_repository.example.id
- name = "somebranch"
- source_sha = azuredevops_git_repository_branch.example_orphan.sha
+ name = "example-from-commit-id"
+ ref_commit_id = azuredevops_git_repository_branch.example.last_commit_id
}
```
@@ -49,30 +44,20 @@ resource "azuredevops_git_repository_branch" "example_from_sha" {
The following arguments are supported:
-- `name` - (Required) The name of the branch (not prefixed with `refs/heads/`).
+- `name` - (Required) The name of the branch in short format not prefixed with `refs/heads/`.
- `repository_id` - (Required) The ID of the repository the branch is created against.
-- `source_ref` - (Optional) The ref the branch is created from. (prefixed with `refs/heads/` or `refs/tags/`)
+- `ref_branch` - (Optional) The reference to the source branch to create the branch from, in `<name>` or `refs/heads/<name>` format. Throws error if set when `ref_tag` or `ref_commit_id` is also set.
-- `source_sha` - (Optional) The commit object id the branch is created from. Set to commit object id of `source_ref` if not given. Otherwise, `source_ref` is ignored.
+- `ref_tag` - (Optional) The reference to the tag to create the branch from, in `<name>` or `refs/tags/<name>` format. Throws error if set when `ref_branch` or `ref_commit_id` is also set.
+
+- `ref_commit_id` - (Optional) The commit object id to create the branch from. Throws error if set when `ref_branch` or `ref_tag` is also set.
## Attributes Reference
In addition to the Arguments listed above - the following Attributes are exported:
-- `id` - The ID of the Git Repository Branch.
-
-- `is_default_branch` - True if the branch is the default branch of the git repository.
+- `id` - The ID of the Git Repository Branch, in the format `<repository_id>:<name>`.
-- `ref` - The branch reference in `refs/heads/<name>` format.
-
-- `sha` - The commit SHA1 object id of the branch tip.
-
-## Import
-
-Git Repository Branches can be imported using the `resource id`, e.g.
-
-```shell
-terraform import azuredevops_git_repository_branch.example 00000000-0000-0000-0000-000000000000:master
-```
+- `last_commit_id` - The commit object id of last commit on the branch.