Skip to content

Commit 7f8cf86

Browse files
gitlab-terraform-provider-botgitlab-terraform-provider-bot
committed
Update docs for v16.3.0 release
1 parent 6e47f04 commit 7f8cf86

17 files changed

+287
-16
lines changed

‎CHANGELOG.md

+26-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,28 @@
1+
## 16.3.0 (2023-08-22)
2+
3+
This release was tested against GitLab 16.0, 16.1, and 16.2 for both CE and EE
4+
5+
IMPROVEMENTS:
6+
7+
- **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))
8+
- **New Resource:** `gitlab_group_epic_board` allows managing epic boards for groups ([!1658](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1658))
9+
- **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))
10+
- 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))
11+
- 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))
12+
- resource/gitlab_group: Add support for `wiki_access_level` ([!1656](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1656))
13+
- resource/gitlab_group_badge: Add support for `name` ([!1655](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1655))
14+
- datasource/gitlab_group: Add support for `wiki_access_level` ([!1656](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1656))
15+
- datasource/gitlab_groups: Add support for `wiki_access_level` ([!1656](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1656))
16+
17+
18+
BUG FIXES:
19+
20+
- resource/gitlab_group_access_token: Require the `expires_at` attribute ([!1661](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1661))
21+
- resource/gitlab_personal_access_token: Require the `expires_at` attribute ([!1661](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1661))
22+
- resource/gitlab_project_access_token: Require the `expires_at` attribute ([!1661](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1661))
23+
- 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))
24+
25+
126
## 16.2.0 (2023-07-22)
227

328
This release was tested against GitLab 15.11, 16.0 and 16.1 for both CE and EE.
@@ -95,7 +120,7 @@ BUG FIXES:
95120
## 16.0.0 (2023-05-22)
96121

97122
- This release was tested against GitLab 15.10, 15.11 and 16.0 for both CE and EE.
98-
- **Note:** this is a major release and breaks some interfaces in resources and data sources of
123+
- **Note:** this is a major release and breaks some interfaces in resources and data sources of
99124
this provider, but also drops support for older GitLab versions.
100125

101126
BREAKING CHANGES:

‎docs/data-sources/group.md

+1
Original file line numberDiff line numberDiff line change
@@ -53,3 +53,4 @@ data "gitlab_group" "foo" {
5353
- `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.
5454
- `visibility_level` (String) Visibility level of the group. Possible values are `private`, `internal`, `public`.
5555
- `web_url` (String) Web URL of the group.
56+
- `wiki_access_level` (String) The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are `disabled`, `private`, `enabled`.

‎docs/data-sources/group_subgroups.md

+1
Original file line numberDiff line numberDiff line change
@@ -79,3 +79,4 @@ Read-Only:
7979
- `two_factor_grace_period` (Number)
8080
- `visibility` (String)
8181
- `web_url` (String)
82+
- `wiki_access_level` (String)

‎docs/data-sources/groups.md

+1
Original file line numberDiff line numberDiff line change
@@ -66,3 +66,4 @@ Read-Only:
6666
- `runners_token` (String)
6767
- `visibility_level` (String)
6868
- `web_url` (String)
69+
- `wiki_access_level` (String)

‎docs/resources/group.md

+1
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ resource "gitlab_project" "example" {
6464
- `subgroup_creation_level` (String) Defaults to owner. Allowed to create subgroups.
6565
- `two_factor_grace_period` (Number) Defaults to 48. Time before Two-factor authentication is enforced (in hours).
6666
- `visibility_level` (String) The group's visibility. Can be `private`, `internal`, or `public`.
67+
- `wiki_access_level` (String) The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are `disabled`, `private`, `enabled`.
6768

6869
### Read-Only
6970

‎docs/resources/group_access_token.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,14 +40,14 @@ resource "gitlab_group_variable" "example" {
4040

4141
### Required
4242

43+
- `expires_at` (String) The token expires at midnight UTC on that date. The date must be in the format YYYY-MM-DD.
4344
- `group` (String) The ID or path of the group to add the group access token to.
4445
- `name` (String) The name of the group access token.
4546
- `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`.
4647

4748
### Optional
4849

4950
- `access_level` (String) The access level for the group access token. Valid values are: `guest`, `reporter`, `developer`, `maintainer`, `owner`.
50-
- `expires_at` (String) The token expires at midnight UTC on that date. The date must be in the format YYYY-MM-DD.
5151

5252
### Read-Only
5353

‎docs/resources/group_badge.md

+4
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,10 @@ resource "gitlab_group_badge" "gitlab_release" {
5757
- `image_url` (String) The image url which will be presented on group overview.
5858
- `link_url` (String) The url linked with the badge.
5959

60+
### Optional
61+
62+
- `name` (String) The name of the badge.
63+
6064
### Read-Only
6165

6266
- `id` (String) The ID of this resource.

‎docs/resources/group_epic_board.md

+84
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "gitlab_group_epic_board Resource - terraform-provider-gitlab"
4+
subcategory: ""
5+
description: |-
6+
The gitlab_group_epic_board resource allows to manage the lifecycle of a epic board in a group.
7+
~> Multiple epic boards on one group requires a GitLab Premium or above License.
8+
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/group_boards.html
9+
---
10+
11+
# gitlab_group_epic_board (Resource)
12+
13+
The `gitlab_group_epic_board` resource allows to manage the lifecycle of a epic board in a group.
14+
15+
~> Multiple epic boards on one group requires a GitLab Premium or above License.
16+
17+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/group_boards.html)
18+
19+
## Example Usage
20+
21+
```terraform
22+
resource "gitlab_group" "example" {
23+
name = "test_group"
24+
path = "test_group"
25+
description = "An example group"
26+
}
27+
28+
resource "gitlab_group_label" "label_1" {
29+
group = gitlab_group.example.id
30+
color = "#FF0000"
31+
name = "red-label"
32+
}
33+
34+
resource "gitlab_group_label" "label_3" {
35+
group = gitlab_group.example.id
36+
name = "label-3"
37+
color = "#003000"
38+
}
39+
40+
resource "gitlab_group_epic_board" "epic_board" {
41+
name = "epic board 6"
42+
group = gitlab_group.example.path
43+
lists {
44+
label_id = gitlab_group_label.label_1.label_id
45+
}
46+
}
47+
```
48+
49+
<!-- schema generated by tfplugindocs -->
50+
## Schema
51+
52+
### Required
53+
54+
- `group` (String) The ID or URL-encoded path of the group owned by the authenticated user.
55+
- `name` (String) The name of the board.
56+
57+
### Optional
58+
59+
- `lists` (Block Set) The list of epic board lists. (see [below for nested schema](#nestedblock--lists))
60+
61+
### Read-Only
62+
63+
- `id` (String) The ID of this Terraform resource. In the format of `<group-id>:<epic-board-id>`.
64+
65+
<a id="nestedblock--lists"></a>
66+
### Nested Schema for `lists`
67+
68+
Optional:
69+
70+
- `label_id` (Number) The ID of the label the list should be scoped to.
71+
72+
Read-Only:
73+
74+
- `id` (Number) The ID of the list.
75+
- `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.
76+
77+
## Import
78+
79+
Import is supported using the following syntax:
80+
81+
```shell
82+
# You can import this resource with an id made up of `{group-id}:{epic-board-id}`, e.g.
83+
terraform import gitlab_group_epic_board.agile 70:156
84+
```

‎docs/resources/group_issue_board.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "gitlab_group_issue_board Resource - terraform-provider-gitlab"
4+
subcategory: ""
5+
description: |-
6+
The gitlab_group_issue_board resource allows to manage the lifecycle of a issue board in a group.
7+
~> Multiple issue boards on one group requires a GitLab Premium or above License.
8+
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/group_boards.html
9+
---
10+
11+
# gitlab_group_issue_board (Resource)
12+
13+
The `gitlab_group_issue_board` resource allows to manage the lifecycle of a issue board in a group.
14+
15+
~> Multiple issue boards on one group requires a GitLab Premium or above License.
16+
17+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/group_boards.html)
18+
19+
20+
21+
<!-- schema generated by tfplugindocs -->
22+
## Schema
23+
24+
### Required
25+
26+
- `group` (String) The ID or URL-encoded path of the group owned by the authenticated user.
27+
- `name` (String) The name of the board.
28+
29+
### Optional
30+
31+
- `lists` (Block Set) The list of issue board lists. (see [below for nested schema](#nestedblock--lists))
32+
- `milestone_id` (Number) The milestone the board should be scoped to.
33+
34+
### Read-Only
35+
36+
- `id` (String) The ID of this Terraform resource. In the format of `<group-id>:<issue-board-id>`.
37+
38+
<a id="nestedblock--lists"></a>
39+
### Nested Schema for `lists`
40+
41+
Optional:
42+
43+
- `label_id` (Number) The ID of the label the list should be scoped to.
44+
45+
Read-Only:
46+
47+
- `id` (Number) The ID of the list.
48+
- `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.

‎docs/resources/personal_access_token.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -39,14 +39,11 @@ resource "gitlab_project_variable" "example" {
3939

4040
### Required
4141

42+
- `expires_at` (String) The token expires at midnight UTC on that date. The date must be in the format YYYY-MM-DD.
4243
- `name` (String) The name of the personal access token.
4344
- `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`.
4445
- `user_id` (Number) The id of the user.
4546

46-
### Optional
47-
48-
- `expires_at` (String) The token expires at midnight UTC on that date. The date must be in the format YYYY-MM-DD.
49-
5047
### Read-Only
5148

5249
- `active` (Boolean) True if the token is active.

‎docs/resources/pipeline_schedule_variable.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ resource "gitlab_pipeline_schedule" "example" {
2525
2626
resource "gitlab_pipeline_schedule_variable" "example" {
2727
project = gitlab_pipeline_schedule.example.project
28-
pipeline_schedule_id = gitlab_pipeline_schedule.example.pipelie_schedule_id
28+
pipeline_schedule_id = gitlab_pipeline_schedule.example.pipeline_schedule_id
2929
key = "EXAMPLE_KEY"
3030
value = "example"
3131
}

‎docs/resources/project_access_token.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,14 @@ resource "gitlab_project_variable" "example" {
3737

3838
### Required
3939

40+
- `expires_at` (String) Time the token will expire it, YYYY-MM-DD format.
4041
- `name` (String) A name to describe the project access token.
4142
- `project` (String) The id of the project to add the project access token to.
4243
- `scopes` (Set of String) Valid values: `api`, `read_api`, `read_repository`, `write_repository`, `read_registry`, `write_registry`.
4344

4445
### Optional
4546

4647
- `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`.
47-
- `expires_at` (String) Time the token will expire it, YYYY-MM-DD format.
4848

4949
### Read-Only
5050

‎docs/resources/project_job_token_scope.md

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "gitlab_project_job_token_scope Resource - terraform-provider-gitlab"
4+
subcategory: ""
5+
description: |-
6+
The gitlab_project_job_token_scope resource allows to manage the CI/CD Job Token scope in a project.
7+
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/project_job_token_scopes.html
8+
---
9+
10+
# gitlab_project_job_token_scope (Resource)
11+
12+
The `gitlab_project_job_token_scope` resource allows to manage the CI/CD Job Token scope in a project.
13+
14+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/project_job_token_scopes.html)
15+
16+
## Example Usage
17+
18+
```terraform
19+
resource "gitlab_project_job_token_scope" "allowed_single_project" {
20+
project = "gitlab-org/gitlab"
21+
target_project_id = 123
22+
}
23+
24+
# Allow multiple projects
25+
locals {
26+
allowed_project_ids = [123, 456, 789]
27+
}
28+
29+
data "gitlab_project" "deployment_project" {
30+
name = "example-project"
31+
}
32+
33+
resource "gitlab_project_job_token_scope" "allowed_project" {
34+
for_each = toset(local.allowed_project_ids)
35+
36+
project = data.gitlab_project.deployment_project.id
37+
target_project_id = each.key
38+
}
39+
```
40+
41+
<!-- schema generated by tfplugindocs -->
42+
## Schema
43+
44+
### Required
45+
46+
- `project` (String) The ID or full path of the project.
47+
- `target_project_id` (Number) The ID of the project that is in the CI/CD job token inbound allowlist.
48+
49+
### Read-Only
50+
51+
- `id` (String) The ID of this Terraform resource. In the format of `<project>:<target-project-id>`.
52+
53+
## Import
54+
55+
Import is supported using the following syntax:
56+
57+
```shell
58+
# GitLab project environments can be imported using an id made up of `projectId:targetProjectId`, e.g.
59+
terraform import gitlab_project_job_token_scope.bar 123:321
60+
```

‎docs/resources/project_level_mr_approvals.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ description: |-
1313
The `gitlab_project_level_mr_approval_rule` resource allows to manage the lifecycle of a Merge Request-level approval rule.
1414

1515
-> This resource requires a GitLab Enterprise instance.
16-
16+
1717
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/merge_request_approvals.html#merge-request-level-mr-approvals)
1818

1919
## Example Usage
@@ -42,15 +42,16 @@ resource "gitlab_project_level_mr_approvals" "foo" {
4242

4343
### Optional
4444

45-
- `disable_overriding_approvers_per_merge_request` (Boolean) By default, users are able to edit the approval rules in merge requests. If set to true,
46-
- `merge_requests_author_approval` (Boolean) Set to `true` if you want to allow merge request authors to self-approve merge requests. Authors
47-
- `merge_requests_disable_committers_approval` (Boolean) Set to `true` if you want to prevent approval of merge requests by merge request committers.
48-
- `require_password_to_approve` (Boolean) Set to `true` if you want to require authentication when approving a merge request.
49-
- `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`.
45+
- `disable_overriding_approvers_per_merge_request` (Boolean) Set to `true` to disable overriding approvers per merge request.
46+
- `merge_requests_author_approval` (Boolean) Set to `true` to allow merge requests authors to approve their own merge requests.
47+
- `merge_requests_disable_committers_approval` (Boolean) Set to `true` to allow merge requests committers to approve their own merge requests.
48+
- `require_password_to_approve` (Boolean) Set to `true` to require authentication to approve merge requests.
49+
- `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`.
50+
- `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.
5051

5152
### Read-Only
5253

53-
- `id` (String) The ID of this resource.
54+
- `id` (String) The ID of the resource. Matches the `project` value.
5455

5556
## Import
5657

‎docs/resources/repository_file.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,6 @@ resource "gitlab_repository_file" "readme_for_dogs" {
7878
### Required
7979

8080
- `branch` (String) Name of the branch to which to commit to.
81-
- `commit_message` (String) Commit message.
8281
- `content` (String) File content.
8382
- `file_path` (String) The full path of the file. It must be relative to the root of the project without a leading slash `/` or `./`.
8483
- `project` (String) The name or ID of the project.
@@ -87,11 +86,15 @@ resource "gitlab_repository_file" "readme_for_dogs" {
8786

8887
- `author_email` (String) Email of the commit author.
8988
- `author_name` (String) Name of the commit author.
89+
- `commit_message` (String) Commit message.
90+
- `create_commit_message` (String) Create commit message.
91+
- `delete_commit_message` (String) Delete Commit message.
9092
- `encoding` (String) The file content encoding. Default value is `base64`. Valid values are: `base64`, `text`.
9193
- `execute_filemode` (Boolean) Enables or disables the execute flag on the file. **Note**: requires GitLab 14.10 or newer.
9294
- `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.
9395
- `start_branch` (String) Name of the branch to start the new commit from.
9496
- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))
97+
- `update_commit_message` (String) Update commit message.
9598

9699
### Read-Only
97100

‎docs/resources/runner.md

+5
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ description: |-
66
The gitlab_runner resource allows to manage the lifecycle of a runner.
77
A runner can either be registered at an instance level or group level.
88
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.
9+
~ > Using this resource will register a runner using the deprecated registration_token flow. To use the new authentication_token flow instead,
10+
use the gitlab_user_runner resource!
911
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/runners.html#register-a-new-runner
1012
---
1113

@@ -16,6 +18,9 @@ The `gitlab_runner` resource allows to manage the lifecycle of a runner.
1618
A runner can either be registered at an instance level or group level.
1719
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.
1820

21+
~ > Using this resource will register a runner using the deprecated `registration_token` flow. To use the new `authentication_token` flow instead,
22+
use the `gitlab_user_runner` resource!
23+
1924
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/runners.html#register-a-new-runner)
2025

2126
## Example Usage

0 commit comments

Comments
 (0)