Update docs for v16.3.0 release

gitlab-terraform-provider-bot · gitlab-terraform-provider-bot · commit 7f8cf860c987 · 2023-08-22T15:41:30.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,28 @@
+## 16.3.0 (2023-08-22)
+
+This release was tested against GitLab 16.0, 16.1, and 16.2 for both CE and EE
+
+IMPROVEMENTS:
+
+- **New Resource:** `gitlab_user_runner` allows managing runners using the new runner flow without using a registration token ([!1618](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1618))
+- **New Resource:** `gitlab_group_epic_board` allows managing epic boards for groups ([!1658](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1658))
+- **New Resource:** `gitlab_project_job_token_allow` allows managing the inbound allow list for a project when using Job Tokens ([!1631](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1631))
+- resource/repository_file: Add the ability to specify a different commit message for Create/Update/Delete operation ([!1629](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1629))
+- resource/gitlab_project_level_mr_approvals: Add support for `selective_code_owner_removals` ([!1641](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1641))
+- resource/gitlab_group: Add support for `wiki_access_level` ([!1656](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1656))
+- resource/gitlab_group_badge: Add support for `name` ([!1655](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1655))
+- datasource/gitlab_group: Add support for `wiki_access_level` ([!1656](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1656))
+- datasource/gitlab_groups: Add support for `wiki_access_level` ([!1656](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1656))
+
+
+BUG FIXES:
+
+- resource/gitlab_group_access_token: Require the `expires_at` attribute ([!1661](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1661))
+- resource/gitlab_personal_access_token: Require the `expires_at` attribute ([!1661](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1661))
+- resource/gitlab_project_access_token: Require the `expires_at` attribute ([!1661](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1661))
+- resource/gitlab_pipeline_schedule_variable: Fix several spelling errors in the documentation that would make examples non-functional ([!1647](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1647))
+
+
 ## 16.2.0 (2023-07-22)
 
 This release was tested against GitLab 15.11, 16.0 and 16.1 for both CE and EE.
@@ -95,7 +120,7 @@ BUG FIXES:
 ## 16.0.0 (2023-05-22)
 
 - This release was tested against GitLab 15.10, 15.11 and 16.0 for both CE and EE.
-- **Note:** this is a major release and breaks some interfaces in resources and data sources of 
+- **Note:** this is a major release and breaks some interfaces in resources and data sources of
   this provider, but also drops support for older GitLab versions.
 
 BREAKING CHANGES:
diff --git a/docs/data-sources/group.md b/docs/data-sources/group.md
@@ -53,3 +53,4 @@ data "gitlab_group" "foo" {
 - `shared_runners_minutes_limit` (Number) Can be set by administrators only. Maximum number of monthly CI/CD minutes for this group. Can be nil (default; inherit system default), 0 (unlimited), or > 0.
 - `visibility_level` (String) Visibility level of the group. Possible values are `private`, `internal`, `public`.
 - `web_url` (String) Web URL of the group.
+- `wiki_access_level` (String) The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are `disabled`, `private`, `enabled`.
diff --git a/docs/data-sources/group_subgroups.md b/docs/data-sources/group_subgroups.md
@@ -79,3 +79,4 @@ Read-Only:
 - `two_factor_grace_period` (Number)
 - `visibility` (String)
 - `web_url` (String)
+- `wiki_access_level` (String)
diff --git a/docs/data-sources/groups.md b/docs/data-sources/groups.md
@@ -66,3 +66,4 @@ Read-Only:
 - `runners_token` (String)
 - `visibility_level` (String)
 - `web_url` (String)
+- `wiki_access_level` (String)
diff --git a/docs/resources/group.md b/docs/resources/group.md
@@ -64,6 +64,7 @@ resource "gitlab_project" "example" {
 - `subgroup_creation_level` (String) Defaults to owner. Allowed to create subgroups.
 - `two_factor_grace_period` (Number) Defaults to 48. Time before Two-factor authentication is enforced (in hours).
 - `visibility_level` (String) The group's visibility. Can be `private`, `internal`, or `public`.
+- `wiki_access_level` (String) The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are `disabled`, `private`, `enabled`.
 
 ### Read-Only
 
diff --git a/docs/resources/group_access_token.md b/docs/resources/group_access_token.md
@@ -40,14 +40,14 @@ resource "gitlab_group_variable" "example" {
 
 ### Required
 
+- `expires_at` (String) The token expires at midnight UTC on that date. The date must be in the format YYYY-MM-DD.
 - `group` (String) The ID or path of the group to add the group access token to.
 - `name` (String) The name of the group access token.
 - `scopes` (Set of String) The scope for the group access token. It determines the actions which can be performed when authenticating with this token. Valid values are: `api`, `read_api`, `read_registry`, `write_registry`, `read_repository`, `write_repository`.
 
 ### Optional
 
 - `access_level` (String) The access level for the group access token. Valid values are: `guest`, `reporter`, `developer`, `maintainer`, `owner`.
-- `expires_at` (String) The token expires at midnight UTC on that date. The date must be in the format YYYY-MM-DD.
 
 ### Read-Only
 
diff --git a/docs/resources/group_badge.md b/docs/resources/group_badge.md
@@ -57,6 +57,10 @@ resource "gitlab_group_badge" "gitlab_release" {
 - `image_url` (String) The image url which will be presented on group overview.
 - `link_url` (String) The url linked with the badge.
 
+### Optional
+
+- `name` (String) The name of the badge.
+
 ### Read-Only
 
 - `id` (String) The ID of this resource.
diff --git a/docs/resources/group_epic_board.md b/docs/resources/group_epic_board.md
@@ -0,0 +1,84 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "gitlab_group_epic_board Resource - terraform-provider-gitlab"
+subcategory: ""
+description: |-
+  The gitlab_group_epic_board resource allows to manage the lifecycle of a epic board in a group.
+  ~> Multiple epic boards on one group requires a GitLab Premium or above License.
+  Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/group_boards.html
+---
+
+# gitlab_group_epic_board (Resource)
+
+The `gitlab_group_epic_board` resource allows to manage the lifecycle of a epic board in a group.
+
+~> Multiple epic boards on one group requires a GitLab Premium or above License.
+
+**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/group_boards.html)
+
+## Example Usage
+
+```terraform
+resource "gitlab_group" "example" {
+  name        = "test_group"
+  path        = "test_group"
+  description = "An example group"
+}
+
+resource "gitlab_group_label" "label_1" {
+  group = gitlab_group.example.id
+  color = "#FF0000"
+  name  = "red-label"
+}
+
+resource "gitlab_group_label" "label_3" {
+  group = gitlab_group.example.id
+  name  = "label-3"
+  color = "#003000"
+}
+
+resource "gitlab_group_epic_board" "epic_board" {
+  name  = "epic board 6"
+  group = gitlab_group.example.path
+  lists {
+    label_id = gitlab_group_label.label_1.label_id
+  }
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `group` (String) The ID or URL-encoded path of the group owned by the authenticated user.
+- `name` (String) The name of the board.
+
+### Optional
+
+- `lists` (Block Set) The list of epic board lists. (see [below for nested schema](#nestedblock--lists))
+
+### Read-Only
+
+- `id` (String) The ID of this Terraform resource. In the format of `<group-id>:<epic-board-id>`.
+
+<a id="nestedblock--lists"></a>
+### Nested Schema for `lists`
+
+Optional:
+
+- `label_id` (Number) The ID of the label the list should be scoped to.
+
+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 sed on the its position in the `lists` array.
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+# You can import this resource with an id made up of `{group-id}:{epic-board-id}`, e.g.
+terraform import gitlab_group_epic_board.agile 70:156
+```
diff --git a/docs/resources/group_issue_board.md b/docs/resources/group_issue_board.md
@@ -0,0 +1,48 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "gitlab_group_issue_board Resource - terraform-provider-gitlab"
+subcategory: ""
+description: |-
+  The gitlab_group_issue_board resource allows to manage the lifecycle of a issue board in a group.
+  ~> Multiple issue boards on one group requires a GitLab Premium or above License.
+  Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/group_boards.html
+---
+
+# gitlab_group_issue_board (Resource)
+
+The `gitlab_group_issue_board` resource allows to manage the lifecycle of a issue board in a group.
+
+~> Multiple issue boards on one group requires a GitLab Premium or above License.
+
+**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/group_boards.html)
+
+
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `group` (String) The ID or URL-encoded path of the group owned by the authenticated user.
+- `name` (String) The name of the board.
+
+### Optional
+
+- `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.
+
+### Read-Only
+
+- `id` (String) The ID of this Terraform resource. In the format of `<group-id>:<issue-board-id>`.
+
+<a id="nestedblock--lists"></a>
+### Nested Schema for `lists`
+
+Optional:
+
+- `label_id` (Number) The ID of the label the list should be scoped to.
+
+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/personal_access_token.md b/docs/resources/personal_access_token.md
@@ -39,14 +39,11 @@ resource "gitlab_project_variable" "example" {
 
 ### Required
 
+- `expires_at` (String) The token expires at midnight UTC on that date. The date must be in the format YYYY-MM-DD.
 - `name` (String) The name of the personal access token.
 - `scopes` (Set of String) The scope for the personal access token. It determines the actions which can be performed when authenticating with this token. Valid values are: `api`, `read_user`, `read_api`, `read_repository`, `write_repository`, `read_registry`, `write_registry`, `sudo`, `admin_mode`.
 - `user_id` (Number) The id of the user.
 
-### Optional
-
-- `expires_at` (String) The token expires at midnight UTC on that date. The date must be in the format YYYY-MM-DD.
-
 ### Read-Only
 
 - `active` (Boolean) True if the token is active.
diff --git a/docs/resources/pipeline_schedule_variable.md b/docs/resources/pipeline_schedule_variable.md
@@ -25,7 +25,7 @@ resource "gitlab_pipeline_schedule" "example" {
 
 resource "gitlab_pipeline_schedule_variable" "example" {
   project              = gitlab_pipeline_schedule.example.project
-  pipeline_schedule_id = gitlab_pipeline_schedule.example.pipelie_schedule_id
+  pipeline_schedule_id = gitlab_pipeline_schedule.example.pipeline_schedule_id
   key                  = "EXAMPLE_KEY"
   value                = "example"
 }
diff --git a/docs/resources/project_access_token.md b/docs/resources/project_access_token.md
@@ -37,14 +37,14 @@ resource "gitlab_project_variable" "example" {
 
 ### Required
 
+- `expires_at` (String) Time the token will expire it, YYYY-MM-DD format.
 - `name` (String) A name to describe the project access token.
 - `project` (String) The id of the project to add the project access token to.
 - `scopes` (Set of String) Valid values: `api`, `read_api`, `read_repository`, `write_repository`, `read_registry`, `write_registry`.
 
 ### Optional
 
 - `access_level` (String) The access level for the project access token. Valid values are: `no one`, `minimal`, `guest`, `reporter`, `developer`, `maintainer`, `owner`, `master`. Default is `maintainer`.
-- `expires_at` (String) Time the token will expire it, YYYY-MM-DD format.
 
 ### Read-Only
 
diff --git a/docs/resources/project_job_token_scope.md b/docs/resources/project_job_token_scope.md
@@ -0,0 +1,60 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "gitlab_project_job_token_scope Resource - terraform-provider-gitlab"
+subcategory: ""
+description: |-
+  The gitlab_project_job_token_scope resource allows to manage the CI/CD Job Token scope in a project.
+  Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/project_job_token_scopes.html
+---
+
+# gitlab_project_job_token_scope (Resource)
+
+The `gitlab_project_job_token_scope` resource allows to manage the CI/CD Job Token scope in a project.
+
+**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/project_job_token_scopes.html)
+
+## Example Usage
+
+```terraform
+resource "gitlab_project_job_token_scope" "allowed_single_project" {
+  project           = "gitlab-org/gitlab"
+  target_project_id = 123
+}
+
+# Allow multiple projects
+locals {
+  allowed_project_ids = [123, 456, 789]
+}
+
+data "gitlab_project" "deployment_project" {
+  name = "example-project"
+}
+
+resource "gitlab_project_job_token_scope" "allowed_project" {
+  for_each = toset(local.allowed_project_ids)
+
+  project           = data.gitlab_project.deployment_project.id
+  target_project_id = each.key
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `project` (String) The ID or full path of the project.
+- `target_project_id` (Number) The ID of the project that is in the CI/CD job token inbound allowlist.
+
+### Read-Only
+
+- `id` (String) The ID of this Terraform resource. In the format of `<project>:<target-project-id>`.
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+# GitLab project environments can be imported using an id made up of `projectId:targetProjectId`, e.g.
+terraform import gitlab_project_job_token_scope.bar 123:321
+```
diff --git a/docs/resources/project_level_mr_approvals.md b/docs/resources/project_level_mr_approvals.md
@@ -13,7 +13,7 @@ description: |-
 The `gitlab_project_level_mr_approval_rule` resource allows to manage the lifecycle of a Merge Request-level approval rule.
 
 -> This resource requires a GitLab Enterprise instance.
-
+		
 **Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/merge_request_approvals.html#merge-request-level-mr-approvals)
 
 ## Example Usage
@@ -42,15 +42,16 @@ resource "gitlab_project_level_mr_approvals" "foo" {
 
 ### Optional
 
-- `disable_overriding_approvers_per_merge_request` (Boolean) By default, users are able to edit the approval rules in merge requests. If set to true,
-- `merge_requests_author_approval` (Boolean) Set to `true` if you want to allow merge request authors to self-approve merge requests. Authors
-- `merge_requests_disable_committers_approval` (Boolean) Set to `true` if you want to prevent approval of merge requests by merge request committers.
-- `require_password_to_approve` (Boolean) Set to `true` if you want to require authentication when approving a merge request.
-- `reset_approvals_on_push` (Boolean) Set to `true` if you want to remove all approvals in a merge request when new commits are pushed to its source branch. Default is `true`.
+- `disable_overriding_approvers_per_merge_request` (Boolean) Set to `true` to disable overriding approvers per merge request.
+- `merge_requests_author_approval` (Boolean) Set to `true` to allow merge requests authors to approve their own merge requests.
+- `merge_requests_disable_committers_approval` (Boolean) Set to `true` to allow merge requests committers to approve their own merge requests.
+- `require_password_to_approve` (Boolean) Set to `true` to require authentication to approve merge requests.
+- `reset_approvals_on_push` (Boolean) Set to `true` to remove all approvals in a merge request when new commits are pushed to its source branch. Default is `true`.
+- `selective_code_owner_removals` (Boolean) Reset approvals from Code Owners if their files changed. Can be enabled only if reset_approvals_on_push is disabled.
 
 ### Read-Only
 
-- `id` (String) The ID of this resource.
+- `id` (String) The ID of the resource. Matches the `project` value.
 
 ## Import
 
diff --git a/docs/resources/repository_file.md b/docs/resources/repository_file.md
@@ -78,7 +78,6 @@ resource "gitlab_repository_file" "readme_for_dogs" {
 ### Required
 
 - `branch` (String) Name of the branch to which to commit to.
-- `commit_message` (String) Commit message.
 - `content` (String) File content.
 - `file_path` (String) The full path of the file. It must be relative to the root of the project without a leading slash `/` or `./`.
 - `project` (String) The name or ID of the project.
@@ -87,11 +86,15 @@ resource "gitlab_repository_file" "readme_for_dogs" {
 
 - `author_email` (String) Email of the commit author.
 - `author_name` (String) Name of the commit author.
+- `commit_message` (String) Commit message.
+- `create_commit_message` (String) Create commit message.
+- `delete_commit_message` (String) Delete Commit message.
 - `encoding` (String) The file content encoding. Default value is `base64`. Valid values are: `base64`, `text`.
 - `execute_filemode` (Boolean) Enables or disables the execute flag on the file. **Note**: requires GitLab 14.10 or newer.
 - `overwrite_on_create` (Boolean) Enable overwriting existing files, defaults to `false`. This attribute is only used during `create` and must be use carefully. We suggest to use `imports` whenever possible and limit the use of this attribute for when the project was imported on the same `apply`. This attribute is not supported during a resource import.
 - `start_branch` (String) Name of the branch to start the new commit from.
 - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))
+- `update_commit_message` (String) Update commit message.
 
 ### Read-Only
 
diff --git a/docs/resources/runner.md b/docs/resources/runner.md
@@ -6,6 +6,8 @@ description: |-
   The gitlab_runner resource allows to manage the lifecycle of a runner.
   A runner can either be registered at an instance level or group level.
   The runner will be registered at a group level if the token used is from a group, or at an instance level if the token used is for the instance.
+  ~ > Using this resource will register a runner using the deprecated registration_token flow. To use the new authentication_token flow instead,
+  use the gitlab_user_runner resource!
   Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/runners.html#register-a-new-runner
 ---
 
@@ -16,6 +18,9 @@ The `gitlab_runner` resource allows to manage the lifecycle of a runner.
 A runner can either be registered at an instance level or group level.
 The runner will be registered at a group level if the token used is from a group, or at an instance level if the token used is for the instance.
 
+~ > Using this resource will register a runner using the deprecated `registration_token` flow. To use the new `authentication_token` flow instead,
+use the `gitlab_user_runner` resource!
+
 **Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/runners.html#register-a-new-runner)
 
 ## Example Usage
diff --git a/docs/resources/user_runner.md b/docs/resources/user_runner.md
