Update docs for v16.7.0 release

gitlab-terraform-provider-bot · gitlab-terraform-provider-bot · commit 196d436b3eda · 2024-01-08T07:18:38.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,24 @@
+## 16.7.0 (2023-12-21)
+
+This release was tested against GitLab 16.5, 16.6, and 16.7 for both CE and EE
+
+DEPRECATION:
+
+- This release updates the recommended Terraform version for this Provider from 1.0.0 to 1.4.0, and updates the version of Terraform we use for CI/CD to 1.4.0 as a result. This is related to a bug that was fixed in Terraform 1.4.0 related to how complex objects are compared. Without using Terraform 1.4.0, the provider cannot guarantee that plan output using nested objects is the same every time. Prior versions will likely still result in a successul plan and apply, but we will ask you to update prior to assisting with issue triage.
+
+IMPROVEMENTS:
+
+- resource/gitlab_branch_protection: Updating `allowed_to_push` will no longer destroy and re-create branch protection, it will instead update it in-place ([!1593](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1593))
+- resource/gitlab_group_issue_board: Issue boards now supports the use of scoped labels, and label position can be explicitly configured ([!1771](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1771))
+- resource/gitlab_project: Add support for `group_runners_enabled` ([!1735](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1735))
+- datasource/gitlab_group: Groups with many projects will now be retrieved significantly faster ([!1770](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1770))
+- datasource/gitlab_project: Add support for `group_runners_enabled` ([!1735](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1735))
+
+BUG FIXES:
+
+- resource/gitlab_pipeline_schedule: Fixed an issue where a pipeline schedule with no owner could cause a provider panic ([!1762](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1762))
+- resource/gitlab_group_ldap_link: Fixed an issue with `force` that could cause an error when attempting to delete an ldap link ([!1757](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1757))
+
 ## 16.6.0 (2023-11-16)
 
 This release was tested against GitLab 16.4, 16.5, and 16.6 for both CE and EE
diff --git a/docs/data-sources/project_protected_branch.md b/docs/data-sources/project_protected_branch.md
@@ -3,13 +3,13 @@
 page_title: "gitlab_project_protected_branch Data Source - terraform-provider-gitlab"
 subcategory: ""
 description: |-
-  The gitlab_protected_branch data source allows details of a protected branch to be retrieved by its name and the project it belongs to.
+  The gitlab_project_protected_branch data source allows details of a protected branch to be retrieved by its name and the project it belongs to.
   Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/protected_branches.html#get-a-single-protected-branch-or-wildcard-protected-branch
 ---
 
 # gitlab_project_protected_branch (Data Source)
 
-The `gitlab_protected_branch` data source allows details of a protected branch to be retrieved by its name and the project it belongs to.
+The `gitlab_project_protected_branch` data source allows details of a protected branch to be retrieved by its name and the project it belongs to.
 
 **Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/protected_branches.html#get-a-single-protected-branch-or-wildcard-protected-branch)
 
@@ -35,31 +35,40 @@ data "gitlab_project_protected_branch" "example" {
 - `name` (String) The name of the protected branch.
 - `project_id` (String) The integer or path with namespace that uniquely identifies the project.
 
+### Optional
+
+- `merge_access_levels` (Block Set) Array of access levels and user(s)/group(s) allowed to merge to protected branch. (see [below for nested schema](#nestedblock--merge_access_levels))
+- `push_access_levels` (Block Set) Array of access levels and user(s)/group(s) allowed to push to protected branch. (see [below for nested schema](#nestedblock--push_access_levels))
+
 ### Read-Only
 
 - `allow_force_push` (Boolean) Whether force push is allowed.
 - `code_owner_approval_required` (Boolean) Reject code pushes that change files listed in the CODEOWNERS file.
 - `id` (Number) The ID of this resource.
-- `merge_access_levels` (List of Object) Describes which access levels, users, or groups are allowed to perform the action. (see [below for nested schema](#nestedatt--merge_access_levels))
-- `push_access_levels` (List of Object) Describes which access levels, users, or groups are allowed to perform the action. (see [below for nested schema](#nestedatt--push_access_levels))
 
-<a id="nestedatt--merge_access_levels"></a>
+<a id="nestedblock--merge_access_levels"></a>
 ### Nested Schema for `merge_access_levels`
 
+Optional:
+
+- `group_id` (Number) The ID of a GitLab group allowed to perform the relevant action. Mutually exclusive with `user_id`.
+- `user_id` (Number) The ID of a GitLab user allowed to perform the relevant action. Mutually exclusive with `group_id`.
+
 Read-Only:
 
-- `access_level` (String)
-- `access_level_description` (String)
-- `group_id` (Number)
-- `user_id` (Number)
+- `access_level` (String) Access levels allowed to merge to protected branch. Valid values are: `no one`, `developer`, `maintainer`.
+- `access_level_description` (String) Readable description of access level.
 
 
-<a id="nestedatt--push_access_levels"></a>
+<a id="nestedblock--push_access_levels"></a>
 ### Nested Schema for `push_access_levels`
 
+Optional:
+
+- `group_id` (Number) The ID of a GitLab group allowed to perform the relevant action. Mutually exclusive with `user_id`.
+- `user_id` (Number) The ID of a GitLab user allowed to perform the relevant action. Mutually exclusive with `group_id`.
+
 Read-Only:
 
-- `access_level` (String)
-- `access_level_description` (String)
-- `group_id` (Number)
-- `user_id` (Number)
+- `access_level` (String) Access levels allowed to push to protected branch. Valid values are: `no one`, `developer`, `maintainer`.
+- `access_level_description` (String) Readable description of access level.
diff --git a/docs/data-sources/project_protected_branches.md b/docs/data-sources/project_protected_branches.md
@@ -32,40 +32,52 @@ data "gitlab_project_protected_branches" "example" {
 
 - `project_id` (String) The integer or path with namespace that uniquely identifies the project.
 
+### Optional
+
+- `protected_branches` (Block List) A list of protected branches, as defined below. (see [below for nested schema](#nestedblock--protected_branches))
+
 ### Read-Only
 
-- `id` (String) The ID of this resource.
-- `protected_branches` (List of Object) A list of protected branches, as defined below. (see [below for nested schema](#nestedatt--protected_branches))
+- `id` (Number) The ID of this resource.
 
-<a id="nestedatt--protected_branches"></a>
+<a id="nestedblock--protected_branches"></a>
 ### Nested Schema for `protected_branches`
 
+Optional:
+
+- `merge_access_levels` (Block Set) Array of access levels and user(s)/group(s) allowed to merge to protected branch. (see [below for nested schema](#nestedblock--protected_branches--merge_access_levels))
+- `push_access_levels` (Block Set) Array of access levels and user(s)/group(s) allowed to push to protected branch. (see [below for nested schema](#nestedblock--protected_branches--push_access_levels))
+
 Read-Only:
 
-- `allow_force_push` (Boolean)
-- `code_owner_approval_required` (Boolean)
-- `id` (Number)
-- `merge_access_levels` (List of Object) (see [below for nested schema](#nestedobjatt--protected_branches--merge_access_levels))
-- `name` (String)
-- `push_access_levels` (List of Object) (see [below for nested schema](#nestedobjatt--protected_branches--push_access_levels))
+- `allow_force_push` (Boolean) Whether force push is allowed.
+- `code_owner_approval_required` (Boolean) Reject code pushes that change files listed in the CODEOWNERS file.
+- `id` (Number) The ID of this resource.
+- `name` (String) The name of the protected branch.
 
-<a id="nestedobjatt--protected_branches--merge_access_levels"></a>
+<a id="nestedblock--protected_branches--merge_access_levels"></a>
 ### Nested Schema for `protected_branches.merge_access_levels`
 
+Optional:
+
+- `group_id` (Number) The ID of a GitLab group allowed to perform the relevant action. Mutually exclusive with `user_id`.
+- `user_id` (Number) The ID of a GitLab user allowed to perform the relevant action. Mutually exclusive with `group_id`.
+
 Read-Only:
 
-- `access_level` (String)
-- `access_level_description` (String)
-- `group_id` (Number)
-- `user_id` (Number)
+- `access_level` (String) Access levels allowed to merge to protected branch. Valid values are: `no one`, `developer`, `maintainer`.
+- `access_level_description` (String) Readable description of access level.
 
 
-<a id="nestedobjatt--protected_branches--push_access_levels"></a>
+<a id="nestedblock--protected_branches--push_access_levels"></a>
 ### Nested Schema for `protected_branches.push_access_levels`
 
+Optional:
+
+- `group_id` (Number) The ID of a GitLab group allowed to perform the relevant action. Mutually exclusive with `user_id`.
+- `user_id` (Number) The ID of a GitLab user allowed to perform the relevant action. Mutually exclusive with `group_id`.
+
 Read-Only:
 
-- `access_level` (String)
-- `access_level_description` (String)
-- `group_id` (Number)
-- `user_id` (Number)
+- `access_level` (String) Access levels allowed to push to protected branch. Valid values are: `no one`, `developer`, `maintainer`.
+- `access_level_description` (String) Readable description of access level.
diff --git a/docs/data-sources/projects.md b/docs/data-sources/projects.md
@@ -112,6 +112,7 @@ Read-Only:
 - `forked_from_project` (List of Object) (see [below for nested schema](#nestedobjatt--projects--forked_from_project))
 - `forking_access_level` (String)
 - `forks_count` (Number)
+- `group_runners_enabled` (Boolean)
 - `http_url_to_repo` (String)
 - `id` (Number)
 - `import_error` (String)
diff --git a/docs/development/CreatingANewResource.md b/docs/development/CreatingANewResource.md
@@ -314,7 +314,7 @@ func (r *gitlabApplicationResource) Create(ctx context.Context, req resource.Cre
 	}
 
 	if !data.Confidential.IsNull() {
-		options.Confidential = gitlab.Bool(data.Confidential.ValueBool())
+		options.Confidential = gitlab.Ptr(data.Confidential.ValueBool())
 	}
 
 	// Create application
diff --git a/docs/index.md b/docs/index.md
@@ -18,6 +18,7 @@ which may be consumed to better understand the behavior of the API.
 Use the navigation to the left to read about the valid data sources and resources.
 
 This provider requires at least [Terraform 1.0](https://www.terraform.io/downloads.html).
+A minimum of Terraform 1.4.0 is recommended.
 
 ## Example Usage
 
diff --git a/docs/resources/branch_protection.md b/docs/resources/branch_protection.md
@@ -90,18 +90,18 @@ resource "gitlab_branch_protection" "main" {
 ### Optional
 
 - `allow_force_push` (Boolean) Can be set to true to allow users with push access to force push.
-- `allowed_to_merge` (Block Set) Defines permissions for action. (see [below for nested schema](#nestedblock--allowed_to_merge))
-- `allowed_to_push` (Block Set) Defines permissions for action. (see [below for nested schema](#nestedblock--allowed_to_push))
-- `allowed_to_unprotect` (Block Set) Defines permissions for action. (see [below for nested schema](#nestedblock--allowed_to_unprotect))
-- `code_owner_approval_required` (Boolean) Can be set to true to require code owner approval before merging. Only available own Premium and Ultimate instances.
+- `allowed_to_merge` (Block Set) Array of access levels and user(s)/group(s) allowed to merge to protected branch. (see [below for nested schema](#nestedblock--allowed_to_merge))
+- `allowed_to_push` (Block Set) Array of access levels and user(s)/group(s) allowed to push to protected branch. (see [below for nested schema](#nestedblock--allowed_to_push))
+- `allowed_to_unprotect` (Block Set) Array of access levels and user(s)/group(s) allowed to unprotect push to protected branch. (see [below for nested schema](#nestedblock--allowed_to_unprotect))
+- `code_owner_approval_required` (Boolean) Can be set to true to require code owner approval before merging. Only available for Premium and Ultimate instances.
 - `merge_access_level` (String) Access levels allowed to merge. Valid values are: `no one`, `developer`, `maintainer`.
 - `push_access_level` (String) Access levels allowed to push. Valid values are: `no one`, `developer`, `maintainer`.
 - `unprotect_access_level` (String) Access levels allowed to unprotect. Valid values are: `developer`, `maintainer`, `admin`.
 
 ### Read-Only
 
 - `branch_protection_id` (Number) The ID of the branch protection (not the branch name).
-- `id` (String) The ID of this resource.
+- `id` (String) The ID of this Terraform resource. In the format of `<project-id:branch>`.
 
 <a id="nestedblock--allowed_to_merge"></a>
 ### Nested Schema for `allowed_to_merge`
@@ -113,8 +113,8 @@ Optional:
 
 Read-Only:
 
-- `access_level` (String) Level of access.
-- `access_level_description` (String) Readable description of level of access.
+- `access_level` (String) Access levels allowed to merge to protected branch. Valid values are: `no one`, `developer`, `maintainer`.
+- `access_level_description` (String) Readable description of access level.
 
 
 <a id="nestedblock--allowed_to_push"></a>
@@ -127,8 +127,8 @@ Optional:
 
 Read-Only:
 
-- `access_level` (String) Level of access.
-- `access_level_description` (String) Readable description of level of access.
+- `access_level` (String) Access levels allowed to push to protected branch. Valid values are: `no one`, `developer`, `maintainer`.
+- `access_level_description` (String) Readable description of access level.
 
 
 <a id="nestedblock--allowed_to_unprotect"></a>
@@ -141,8 +141,8 @@ Optional:
 
 Read-Only:
 
-- `access_level` (String) Level of access.
-- `access_level_description` (String) Readable description of level of access.
+- `access_level` (String) Access levels allowed to unprotect push to protected branch. Valid values are: `developer`, `maintainer`, `admin`.
+- `access_level_description` (String) Readable description of access level.
 
 ## Import
 
diff --git a/docs/resources/group_issue_board.md b/docs/resources/group_issue_board.md
@@ -28,6 +28,7 @@ The `gitlab_group_issue_board` resource allows to manage the lifecycle of a issu
 
 ### Optional
 
+- `labels` (Set of String) The list of label names which the board should be scoped to.
 - `lists` (Block Set) The list of issue board lists. (see [below for nested schema](#nestedblock--lists))
 - `milestone_id` (Number) The milestone the board should be scoped to.
 
@@ -41,8 +42,8 @@ The `gitlab_group_issue_board` resource allows to manage the lifecycle of a issu
 Optional:
 
 - `label_id` (Number) The ID of the label the list should be scoped to.
+- `position` (Number) The explicit position of the list within the board, zero based.
 
 Read-Only:
 
 - `id` (Number) The ID of the list.
-- `position` (Number) The position of the list within the board. The position for the list is based on the its position in the `lists` array.
diff --git a/docs/resources/project.md b/docs/resources/project.md
@@ -165,6 +165,7 @@ resource "gitlab_project" "import_private" {
 - `feature_flags_access_level` (String) Set the feature flags access level. Valid values are `disabled`, `private`, `enabled`.
 - `forked_from_project_id` (Number) The id of the project to fork. During create the project is forked and during an update the fork relation is changed.
 - `forking_access_level` (String) Set the forking access level. Valid values are `disabled`, `private`, `enabled`.
+- `group_runners_enabled` (Boolean) Enable group runners for this project.
 - `group_with_project_templates_id` (Number) For group-level custom templates, specifies ID of group from which all the custom project templates are sourced. Leave empty for instance-level templates. Requires use_custom_template to be true (enterprise edition).
 - `import_url` (String) Git URL to a repository to be imported. Together with `mirror = true` it will setup a Pull Mirror. This can also be used together with `forked_from_project_id` to setup a Pull Mirror for a fork. The fork takes precedence over the import. Make sure to provide the credentials in `import_url_username` and `import_url_password`. GitLab never returns the credentials, thus the provider cannot detect configuration drift in the credentials. They can also not be imported using `terraform import`. See the examples section for how to properly use it.
 - `import_url_password` (String, Sensitive) The password for the `import_url`. The value of this field is used to construct a valid `import_url` and is only related to the provider. This field cannot be imported using `terraform import`. See the examples section for how to properly use it.
diff --git a/docs/resources/project_access_token.md b/docs/resources/project_access_token.md
@@ -4,13 +4,16 @@ page_title: "gitlab_project_access_token Resource - terraform-provider-gitlab"
 subcategory: ""
 description: |-
   The gitlab_project_access_token resource allows to manage the lifecycle of a project access token.
+  ~>  Use of the timestamp() function with expires_at will cause the resource to be re-created with every apply, it's recommended to use plantimestamp() or a static value instead.
   Upstream API: GitLab API docs https://docs.gitlab.com/ee/api/project_access_tokens.html
 ---
 
 # gitlab_project_access_token (Resource)
 
 The `gitlab_project_access_token` resource allows to manage the lifecycle of a project access token.
 
+~>  Use of the `timestamp()` function with expires_at will cause the resource to be re-created with every apply, it's recommended to use `plantimestamp()` or a static value instead.
+
 **Upstream API**: [GitLab API docs](https://docs.gitlab.com/ee/api/project_access_tokens.html)
 
 ## Example Usage

Original file line number	Diff line number	Diff line change
`@@ -314,7 +314,7 @@ func (r *gitlabApplicationResource) Create(ctx context.Context, req resource.Cre`
`314`	`314`	`}`
`315`	`315`
`316`	`316`	`if !data.Confidential.IsNull() {`
`317`		`- options.Confidential = gitlab.Bool(data.Confidential.ValueBool())`
	`317`	`+ options.Confidential = gitlab.Ptr(data.Confidential.ValueBool())`
`318`	`318`	`}`
`319`	`319`
`320`	`320`	`// Create application`