Merge branch 'main' of github.com:Moon1706/terraform-provider-gitlab into main

Author: SharaevN

.github/workflows/issue-opened.yml

@@ -25,7 +25,7 @@ jobs:
       # This prevents the needs-triage label from being added.
       - uses: actions/checkout@v3
         if: ${{ failure() }}
-      - uses: github/issue-labeler@v2.4
+      - uses: github/issue-labeler@v2.5
         if: ${{ failure() }}
         with:
           repo-token: "${{ secrets.GITHUB_TOKEN }}"

.github/workflows/pr-lint.yml

@@ -28,7 +28,6 @@ jobs:
       matrix:
         target:
           - lint-golangci
-          - lint-tfprovider
           - lint-examples-tf
           - lint-examples-sh
           - lint-generated

.github/workflows/push.yml

@@ -40,7 +40,6 @@ jobs:
       matrix:
         target:
           - lint-golangci
-          - lint-tfprovider
           - lint-examples-tf
           - lint-examples-sh
           - lint-generated

.go-version

@@ -1 +1 @@
-1.16
+1.17

.golangci.yml

@@ -4,10 +4,16 @@ run:
   timeout: 3m
 
 linters-settings:
+  custom:
+    tfproviderlint:
+      path: ./bin/tfproviderlint-plugin.so
+      description: "Terraform Provider Lint Tool"
+      original-url: https://github.com/bflad/tfproviderlint
   errcheck:
     exclude: errcheck_excludes.txt
 
 linters:
   enable:
     - gofmt
     - govet
+    - tfproviderlint

.vscode/settings.json

@@ -1,8 +1,8 @@
 {
-  "go.testEnvVars": {
-    "TF_ACC": "1",
-    "GITLAB_TOKEN": "ACCTEST1234567890123",
-    "GITLAB_BASE_URL": "http://127.0.0.1:8080"
-  },
-  "go.testFlags": ["-count=1", "-v", "-timeout=30m"]
+    "go.testEnvVars": {
+        "TF_ACC": "1",
+        "GITLAB_TOKEN": "ACCTEST1234567890123",
+        "GITLAB_BASE_URL": "http://127.0.0.1:8080"
+    },
+    "go.testFlags": ["-count=1", "-v", "-tags=acceptance", "-tags=acceptance"]
 }

CONTRIBUTING.md

@@ -62,7 +62,7 @@ Documentation in [/docs](/docs) is auto-generated by [terraform-plugin-docs](htt
 
 ### Set Up Your Local Environment
 
-You'll first need [Go](http://www.golang.org) installed on your machine (version 1.16+ is *required*).
+You'll first need [Go](http://www.golang.org) installed on your machine (version 1.17+ is *required*).
 
 1. Clone the git repository.
 

GNUmakefile

@@ -21,20 +21,14 @@ endif
 test: ## Run unit tests.
 	go test $(TESTARGS) $(PROVIDER_SRC_DIR)
 
-TFPROVIDERLINTX_CHECKS = -XAT001=false -XR003=false -XS002=false
-
-fmt: tool-golangci-lint tool-tfproviderlintx tool-terraform tool-shfmt ## Format files and fix issues.
+fmt: tool-golangci-lint tool-terraform tool-shfmt tfproviderlint-plugin ## Format files and fix issues.
 	gofmt -w -s .
-	$(GOBIN)/golangci-lint run --fix
-	$(GOBIN)/tfproviderlintx $(TFPROVIDERLINTX_CHECKS) --fix ./...
+	$(GOBIN)/golangci-lint run --build-tags acceptance --fix
 	$(GOBIN)/terraform fmt -recursive -list ./examples
 	$(GOBIN)/shfmt -l -s -w ./examples
 
-lint-golangci: tool-golangci-lint ## Run golangci-lint linter (same as fmt but without modifying files).
-	$(GOBIN)/golangci-lint run
-
-lint-tfprovider: tool-tfproviderlintx ## Run tfproviderlintx linter (same as fmt but without modifying files).
-	$(GOBIN)/tfproviderlintx $(TFPROVIDERLINTX_CHECKS) ./...
+lint-golangci: tool-golangci-lint tfproviderlint-plugin ## Run golangci-lint linter (same as fmt but without modifying files).
+	$(GOBIN)/golangci-lint run --build-tags acceptance
 
 lint-examples-tf: tool-terraform ## Run terraform linter on examples (same as fmt but without modifying files).
 	$(GOBIN)/terraform fmt -recursive -check ./examples
@@ -73,7 +67,7 @@ testacc-down: ## Teardown a GitLab instance.
 	docker-compose down --volumes
 
 testacc: ## Run acceptance tests against a GitLab instance.
-	TF_ACC=1 GITLAB_TOKEN=$(GITLAB_TOKEN) GITLAB_BASE_URL=$(GITLAB_BASE_URL) go test -v $(PROVIDER_SRC_DIR) $(TESTARGS) -timeout 40m
+	TF_ACC=1 GITLAB_TOKEN=$(GITLAB_TOKEN) GITLAB_BASE_URL=$(GITLAB_BASE_URL) go test --tags acceptance -v $(PROVIDER_SRC_DIR) $(TESTARGS) -timeout 40m
 
 certs: ## Generate certs for the GitLab container registry
 	mkdir -p certs
@@ -85,9 +79,6 @@ certs: ## Generate certs for the GitLab container registry
 tool-golangci-lint:
 	@$(call install-tool, github.com/golangci/golangci-lint/cmd/golangci-lint)
 
-tool-tfproviderlintx:
-	@$(call install-tool, github.com/bflad/tfproviderlint/cmd/tfproviderlintx)
-
 tool-tfplugindocs:
 	@$(call install-tool, github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs)
 
@@ -110,4 +101,7 @@ tool-terraform:
 	@[ -f $(GOBIN)/terraform ] || { mkdir -p tmp; cd tmp; rm -rf terraform; git clone --branch $(TERRAFORM_VERSION) --depth 1 https://github.com/hashicorp/terraform.git; cd terraform; GOBIN=$(GOBIN) go install; cd ..; rm -rf terraform; }
 
 clean: testacc-down
-	@rm -rf certs/
+	@rm -rf certs/
+
+tfproviderlint-plugin:
+	@cd tools && go build -buildmode=plugin -o $(GOBIN)/tfproviderlint-plugin.so ./cmd/tfproviderlint-plugin

README.md

@@ -17,3 +17,11 @@ GitLab resources, like users, groups and projects.
 ## Contributing
 
 Check out the [CONTRIBUTING.md](/CONTRIBUTING.md) guide for tips on how to contribute and develop the provider.
+
+## Community
+
+You are welcome to join our [Discord Server](https://discord.gg/CCc6Pe5EYy) or the monthly community hours:
+
+- [Google Calendar signup](https://calendar.google.com/event?action=TEMPLATE&tmeid=MnZyN2owdmYxaDdiMWdjNGdoMzQ3bWM0dDlfMjAyMjA0MjdUMTQzMDAwWiBjXzh0bjczaDNjYW5mam1zY2pwamJqNjFpNDVrQGc&tmsrc=c_8tn73h3canfjmscjpjbj61i45k%40group.calendar.google.com&scp=ALL )
+- [Recordings](https://www.youtube.com/playlist?list=PL05JrBw4t0KrMncKb6v9S0wB_liBky39P)
+- [Notes](https://docs.google.com/document/d/1-rgmylTUlO2lPRmbmGk0aB-mktg8nYu0NxOkFw9bo_M/edit#)

docs/data-sources/group_variable.md

@@ -13,7 +13,21 @@ The `gitlab_group_variable` data source allows to retrieve details about a group
 
 **Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/group_level_variables.html)
 
-
+## Example Usage
+
+```terraform
+data "gitlab_group_variable" "foo" {
+  group = "my/example/group"
+  key   = "foo"
+}
+
+# Using an environment scope
+data "gitlab_group_variable" "bar" {
+  group             = "my/example/group"
+  key               = "bar"
+  environment_scope = "staging/*"
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/data-sources/group_variables.md

@@ -13,7 +13,19 @@ The `gitlab_group_variables` data source allows to retrieve all group-level CI/C
 
 **Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/group_level_variables.html)
 
-
+## Example Usage
+
+```terraform
+data "gitlab_group_variables" "vars" {
+  group = "my/example/group"
+}
+
+# Using an environment scope
+data "gitlab_group_variables" "staging_vars" {
+  group             = "my/example/group"
+  environment_scope = "staging/*"
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/data-sources/instance_variable.md

@@ -13,7 +13,13 @@ The `gitlab_instance_variable` data source allows to retrieve details about an i
 
 **Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/instance_level_ci_variables.html)
 
+## Example Usage
 
+```terraform
+data "gitlab_instance_variable" "foo" {
+  key = "foo"
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/data-sources/instance_variables.md

@@ -13,7 +13,11 @@ The `gitlab_instance_variables` data source allows to retrieve all instance-leve
 
 **Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/instance_level_ci_variables.html)
 
+## Example Usage
 
+```terraform
+data "gitlab_instance_variables" "vars" {}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/data-sources/project_variable.md

@@ -13,7 +13,21 @@ The `gitlab_project_variable` data source allows to retrieve details about a pro
 
 **Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/project_level_variables.html)
 
-
+## Example Usage
+
+```terraform
+data "gitlab_project_variable" "foo" {
+  project = "my/example/project"
+  key     = "foo"
+}
+
+# Using an environment scope
+data "gitlab_project_variable" "bar" {
+  project           = "my/example/project"
+  key               = "bar"
+  environment_scope = "staging/*"
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/data-sources/project_variables.md

@@ -13,7 +13,19 @@ The `gitlab_project_variables` data source allows to retrieve all project-level
 
 **Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/project_level_variables.html)
 
-
+## Example Usage
+
+```terraform
+data "gitlab_project_variables" "vars" {
+  project = "my/example/project"
+}
+
+# Using an environment scope
+data "gitlab_project_variables" "staging_vars" {
+  project           = "my/example/project"
+  environment_scope = "staging/*"
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/resources/group_share_group.md

@@ -30,8 +30,8 @@ resource "gitlab_group_share_group" "test" {
 ### Required
 
 - `group_access` (String) The access level to grant the group. Valid values are: `no one`, `minimal`, `guest`, `reporter`, `developer`, `maintainer`, `owner`, `master`
-- `group_id` (String) The id of the main group.
-- `share_group_id` (Number) The id of an additional group which will be shared with the main group.
+- `group_id` (String) The id of the main group to be shared.
+- `share_group_id` (Number) The id of the additional group with which the main group will be shared.
 
 ### Optional
 

docs/resources/project_issue.md

@@ -54,8 +54,6 @@ output "welcome_issue_web_url" {
 ### Optional
 
 - `assignee_ids` (Set of Number) The IDs of the users to assign the issue to.
-- `closed_at` (String) When the issue was closed. Date time string, ISO 8601 formatted, for example 2016-03-11T03:45:40Z.
-- `closed_by_user_id` (Number) The ID of the user that closed the issue. Use `gitlab_user` data source to get more information about the user.
 - `confidential` (Boolean) Set an issue to be confidential.
 - `created_at` (String) When the issue was created. Date time string, ISO 8601 formatted, for example 2016-03-11T03:45:40Z. Requires administrator or project/group owner rights.
 - `delete_on_destroy` (Boolean) Whether the issue is deleted instead of closed during destroy.
@@ -65,45 +63,47 @@ output "welcome_issue_web_url" {
 - `due_date` (String) The due date. Date time string in the format YYYY-MM-DD, for example 2016-03-11.
 **Note:** removing a due date is currently not supported, see https://github.com/xanzy/go-gitlab/issues/1384 for details.
 - `epic_issue_id` (Number) The ID of the epic issue.
-- `human_time_estimate` (String) The human-readable time estimate of the issue.
-- `human_total_time_spent` (String) The human-readable total time spent of the issue.
 - `iid` (Number) The internal ID of the project's issue.
 - `issue_type` (String) The type of issue. Valid values are: `issue`, `incident`, `test_case`.
 - `labels` (Set of String) The labels of an issue.
-- `links` (Map of String) The links of the issue.
 - `merge_request_to_resolve_discussions_of` (Number) The IID of a merge request in which to resolve all issues. This fills out the issue with a default description and mark all discussions as resolved. When passing a description or title, these values take precedence over the default values.
 - `milestone_id` (Number) The global ID of a milestone to assign issue. To find the milestone_id associated with a milestone, view an issue with the milestone assigned and use the API to retrieve the issue's details.
-- `references` (Map of String) The references of the issue.
 - `state` (String) The state of the issue. Valid values are: `opened`, `closed`.
-- `task_completion_status` (Block List, Max: 1) The task completion status. It's always a one element list. (see [below for nested schema](#nestedblock--task_completion_status))
-- `time_estimate` (Number) The time estimate of the issue.
-- `total_time_spent` (Number) The total time spent of the issue.
 - `updated_at` (String) When the issue was updated. Date time string, ISO 8601 formatted, for example 2016-03-11T03:45:40Z.
 - `weight` (Number) The weight of the issue. Valid values are greater than or equal to 0.
 
 ### Read-Only
 
 - `author_id` (Number) The ID of the author of the issue. Use `gitlab_user` data source to get more information about the user.
+- `closed_at` (String) When the issue was closed. Date time string, ISO 8601 formatted, for example 2016-03-11T03:45:40Z.
+- `closed_by_user_id` (Number) The ID of the user that closed the issue. Use `gitlab_user` data source to get more information about the user.
 - `downvotes` (Number) The number of downvotes the issue has received.
 - `epic_id` (Number) ID of the epic to add the issue to. Valid values are greater than or equal to 0.
 - `external_id` (String) The external ID of the issue.
+- `human_time_estimate` (String) The human-readable time estimate of the issue.
+- `human_total_time_spent` (String) The human-readable total time spent of the issue.
 - `id` (String) The ID of this resource.
 - `issue_id` (Number) The instance-wide ID of the issue.
 - `issue_link_id` (Number) The ID of the issue link.
+- `links` (Map of String) The links of the issue.
 - `merge_requests_count` (Number) The number of merge requests associated with the issue.
 - `moved_to_id` (Number) The ID of the issue that was moved to.
+- `references` (Map of String) The references of the issue.
 - `subscribed` (Boolean) Whether the authenticated user is subscribed to the issue or not.
+- `task_completion_status` (List of Object) The task completion status. It's always a one element list. (see [below for nested schema](#nestedatt--task_completion_status))
+- `time_estimate` (Number) The time estimate of the issue.
+- `total_time_spent` (Number) The total time spent of the issue.
 - `upvotes` (Number) The number of upvotes the issue has received.
 - `user_notes_count` (Number) The number of user notes on the issue.
 - `web_url` (String) The web URL of the issue.
 
-<a id="nestedblock--task_completion_status"></a>
+<a id="nestedatt--task_completion_status"></a>
 ### Nested Schema for `task_completion_status`
 
-Optional:
+Read-Only:
 
-- `completed_count` (Number) The number of tasks that are completed.
-- `count` (Number) The number of tasks.
+- `completed_count` (Number)
+- `count` (Number)
 
 ## Import
 

examples/data-sources/gitlab_group_variable/data-source.tf

@@ -0,0 +1,11 @@
+data "gitlab_group_variable" "foo" {
+  group = "my/example/group"
+  key   = "foo"
+}
+
+# Using an environment scope
+data "gitlab_group_variable" "bar" {
+  group             = "my/example/group"
+  key               = "bar"
+  environment_scope = "staging/*"
+}

examples/data-sources/gitlab_group_variables/data-source.tf

@@ -0,0 +1,9 @@
+data "gitlab_group_variables" "vars" {
+  group = "my/example/group"
+}
+
+# Using an environment scope
+data "gitlab_group_variables" "staging_vars" {
+  group             = "my/example/group"
+  environment_scope = "staging/*"
+}

examples/data-sources/gitlab_instance_variable/data-source.tf

@@ -0,0 +1,3 @@
+data "gitlab_instance_variable" "foo" {
+  key = "foo"
+}

examples/data-sources/gitlab_instance_variables/data-source.tf

@@ -0,0 +1 @@
+data "gitlab_instance_variables" "vars" {}

examples/data-sources/gitlab_project_variable/data-source.tf

@@ -0,0 +1,11 @@
+data "gitlab_project_variable" "foo" {
+  project = "my/example/project"
+  key     = "foo"
+}
+
+# Using an environment scope
+data "gitlab_project_variable" "bar" {
+  project           = "my/example/project"
+  key               = "bar"
+  environment_scope = "staging/*"
+}

examples/data-sources/gitlab_project_variables/data-source.tf

@@ -0,0 +1,9 @@
+data "gitlab_project_variables" "vars" {
+  project = "my/example/project"
+}
+
+# Using an environment scope
+data "gitlab_project_variables" "staging_vars" {
+  project           = "my/example/project"
+  environment_scope = "staging/*"
+}