Skip to content

Commit 39c758a

Browse files
committed
resource/gitlab_project_variable: Improve documentation and reference upstream docs
1 parent 39422d7 commit 39c758a

File tree

2 files changed

+12
-21
lines changed

2 files changed

+12
-21
lines changed

docs/resources/project_variable.md

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,18 @@
33
page_title: "gitlab_project_variable Resource - terraform-provider-gitlab"
44
subcategory: ""
55
description: |-
6-
This resource allows you to create and manage CI/CD variables for your GitLab projects.
7-
For further information on variables, consult the gitlab
8-
documentation https://docs.gitlab.com/ce/ci/variables/README.html#variables.
9-
~> Important: If your GitLab version is older than 13.4, you may see nondeterministic behavior
10-
when updating or deleting gitlab_project_variable resources with non-unique keys, for example if
11-
there is another variable with the same key and different environment scope. See
12-
this GitLab issue https://gitlab.com/gitlab-org/gitlab/-/issues/9912.
6+
The gitlab_project_variable resource allows to manage the lifecycle of a CI/CD variable for a project.
7+
~> Important: If your GitLab version is older than 13.4, you may see nondeterministic behavior when updating or deleting gitlabprojectvariable resources with non-unique keys, for example if there is another variable with the same key and different environment scope. See this GitLab issue https://gitlab.com/gitlab-org/gitlab/-/issues/9912.
8+
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/project_level_variables.html
139
---
1410

1511
# gitlab_project_variable (Resource)
1612

17-
This resource allows you to create and manage CI/CD variables for your GitLab projects.
18-
For further information on variables, consult the [gitlab
19-
documentation](https://docs.gitlab.com/ce/ci/variables/README.html#variables).
13+
The `gitlab_project_variable` resource allows to manage the lifecycle of a CI/CD variable for a project.
2014

21-
~> **Important:** If your GitLab version is older than 13.4, you may see nondeterministic behavior
22-
when updating or deleting `gitlab_project_variable` resources with non-unique keys, for example if
23-
there is another variable with the same key and different environment scope. See
24-
[this GitLab issue](https://gitlab.com/gitlab-org/gitlab/-/issues/9912).
15+
~> **Important:** If your GitLab version is older than 13.4, you may see nondeterministic behavior when updating or deleting gitlab_project_variable resources with non-unique keys, for example if there is another variable with the same key and different environment scope. See [this GitLab issue](https://gitlab.com/gitlab-org/gitlab/-/issues/9912).
16+
17+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/project_level_variables.html)
2518

2619
## Example Usage
2720

internal/provider/resource_gitlab_project_variable.go

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,11 @@ import (
1313

1414
var _ = registerResource("gitlab_project_variable", func() *schema.Resource {
1515
return &schema.Resource{
16-
Description: "This resource allows you to create and manage CI/CD variables for your GitLab projects.\n" +
17-
"For further information on variables, consult the [gitlab\n" +
18-
"documentation](https://docs.gitlab.com/ce/ci/variables/README.html#variables).\n\n" +
19-
"~> **Important:** If your GitLab version is older than 13.4, you may see nondeterministic behavior\n" +
20-
"when updating or deleting `gitlab_project_variable` resources with non-unique keys, for example if\n" +
21-
"there is another variable with the same key and different environment scope. See\n" +
22-
"[this GitLab issue](https://gitlab.com/gitlab-org/gitlab/-/issues/9912).",
16+
Description: `The ` + "`" + `gitlab_project_variable` + "`" + ` resource allows to manage the lifecycle of a CI/CD variable for a project.
17+
18+
~> **Important:** If your GitLab version is older than 13.4, you may see nondeterministic behavior when updating or deleting gitlab_project_variable resources with non-unique keys, for example if there is another variable with the same key and different environment scope. See [this GitLab issue](https://gitlab.com/gitlab-org/gitlab/-/issues/9912).
19+
20+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/project_level_variables.html)`,
2321

2422
CreateContext: resourceGitlabProjectVariableCreate,
2523
ReadContext: resourceGitlabProjectVariableRead,

0 commit comments

Comments
 (0)