Skip to content

Commit 121cb5d

Browse files
Update docs for v18.4.0 release
1 parent a584660 commit 121cb5d

24 files changed

+363
-188
lines changed

CHANGELOG.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
## 18.4.0 (2025-09-18)
2+
3+
### FEATURES (2 changes)
4+
5+
- resource/gitlab_group_level_mr_approvals: [Add group level merge request approvals resource](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/4b8e3977ea9caaef1346ffc63f2a2da2bffadd49) by @heidi.berry ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2588))
6+
- resource/gitlab_project_external_status_check: [Add new resource for project external status checks](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/72fd42ed6093b3a87d1ed22d3d30d34f2194ef43) by @mness ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2633))
7+
8+
### IMPROVEMENTS (1 change)
9+
10+
- resource/gitlab_project_hook: [Update docs to indicate which version of GitLab is required to use custom headers](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/d61ae3b605a28b3535f2d28527e79941b62500e9) by @heidi.berry ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2663))
11+
12+
### BUG FIXES (2 changes)
13+
14+
- resource/gitlab_group_service_account: [Wait for group service account users to be deleted during destroy](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/5bccb8f83e4e2994af9e19812428c756ca577da8) by @heidi.berry ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2649))
15+
- resource/gitlab_group_share_group: [Add feature flag information for using custom roles](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/70e1ed298d0f28430bb3d9138f2d49282fcd9b9e) by @heidi.berry ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2667))
16+
117
## 18.3.0 (2025-08-22)
218

319
### FEATURES (3 changes)

docs/data-sources/branch.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@ data "gitlab_branch" "foo" {
4040
### Read-Only
4141

4242
- `can_push` (Boolean) Bool, true if you can push to the branch.
43-
- `commit` (Set of Object) The commit associated with the branch ref. (see [below for nested schema](#nestedatt--commit))
43+
- `commit` (Attributes Set) The commit associated with the branch ref. (see [below for nested schema](#nestedatt--commit))
4444
- `default` (Boolean) Bool, true if branch is the default branch for the project.
4545
- `developer_can_merge` (Boolean) Bool, true if developer level access allows to merge branch.
4646
- `developer_can_push` (Boolean) Bool, true if developer level access allows git push.
47-
- `id` (String) The ID of this resource.
47+
- `id` (String) The ID of this datasource. In the format `<project:name>`.
4848
- `merged` (Boolean) Bool, true if the branch has been merged into its parent.
4949
- `protected` (Boolean) Bool, true if branch has branch protection.
5050
- `web_url` (String) The url of the created branch (https.)
@@ -54,14 +54,14 @@ data "gitlab_branch" "foo" {
5454

5555
Read-Only:
5656

57-
- `author_email` (String)
58-
- `author_name` (String)
59-
- `authored_date` (String)
60-
- `committed_date` (String)
61-
- `committer_email` (String)
62-
- `committer_name` (String)
63-
- `id` (String)
64-
- `message` (String)
65-
- `parent_ids` (Set of String)
66-
- `short_id` (String)
67-
- `title` (String)
57+
- `author_email` (String) The email of the author.
58+
- `author_name` (String) The name of the author.
59+
- `authored_date` (String) The date which the commit was authored (format: yyyy-MM-ddTHH:mm:ssZ).
60+
- `committed_date` (String) The date at which the commit was pushed (format: yyyy-MM-ddTHH:mm:ssZ).
61+
- `committer_email` (String) The email of the user that committed.
62+
- `committer_name` (String) The name of the user that committed.
63+
- `id` (String) The unique id assigned to the commit by Gitlab.
64+
- `message` (String) The commit message
65+
- `parent_ids` (Set of String) The id of the parents of the commit
66+
- `short_id` (String) The short id assigned to the commit by Gitlab.
67+
- `title` (String) The title of the commit

docs/data-sources/cluster_agent.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
page_title: "gitlab_cluster_agent Data Source - terraform-provider-gitlab"
44
subcategory: ""
55
description: |-
6-
The gitlab_cluster_agent data source allows to retrieve details about a GitLab Agent for Kubernetes.
6+
The gitlab_cluster_agent data source retrieves details about a GitLab Agent for Kubernetes.
77
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/cluster_agents/
88
---
99

1010
# gitlab_cluster_agent (Data Source)
1111

12-
The `gitlab_cluster_agent` data source allows to retrieve details about a GitLab Agent for Kubernetes.
12+
The `gitlab_cluster_agent` data source retrieves details about a GitLab Agent for Kubernetes.
1313

1414
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/cluster_agents/)
1515

@@ -34,5 +34,5 @@ data "gitlab_cluster_agent" "example" {
3434

3535
- `created_at` (String) The ISO8601 datetime when the agent was created.
3636
- `created_by_user_id` (Number) The ID of the user who created the agent.
37-
- `id` (String) The ID of this resource.
37+
- `id` (String) The ID of this data source. In the format <project:agent_id>
3838
- `name` (String) The Name of the agent.

docs/data-sources/current_user.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,5 +31,5 @@ data "gitlab_current_user" "example" {}
3131
- `id` (String) ID of the user.
3232
- `name` (String) Human-readable name of the user. Returns **** if the user is a project bot and the requester does not have permission to view the project.
3333
- `namespace_id` (String) Personal namespace of the user.
34-
- `public_email` (String) Users public email.
34+
- `public_email` (String) User's public email.
3535
- `username` (String) Username of the user. Unique within this instance of GitLab.

docs/data-sources/group_hook.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ data "gitlab_group_hook" "example" {
4343
- `emoji_events` (Boolean) Invoke the hook for emoji events.
4444
- `enable_ssl_verification` (Boolean) Enable ssl verification when invoking the hook.
4545
- `group_id` (Number) The id of the group for the hook.
46-
- `id` (String) The ID of this resource.
46+
- `id` (String) The ID of this data source. In the format `<group:hook_id>`.
4747
- `issues_events` (Boolean) Invoke the hook for issues events.
4848
- `job_events` (Boolean) Invoke the hook for job events.
4949
- `merge_requests_events` (Boolean) Invoke the hook for merge requests.
@@ -54,6 +54,6 @@ data "gitlab_group_hook" "example" {
5454
- `releases_events` (Boolean) Invoke the hook for releases events.
5555
- `subgroup_events` (Boolean) Invoke the hook for subgroup events.
5656
- `tag_push_events` (Boolean) Invoke the hook for tag push events.
57-
- `token` (String) A token to present when invoking the hook. The token is not available for imported resources.
57+
- `token` (String, Deprecated) A token to present when invoking the hook. The token is not available in this datasource.
5858
- `url` (String) The url of the hook to invoke.
5959
- `wiki_page_events` (Boolean) Invoke the hook for wiki page events.

docs/data-sources/instance_deploy_keys.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -36,30 +36,30 @@ data "gitlab_instance_deploy_keys" "example" {
3636

3737
### Read-Only
3838

39-
- `deploy_keys` (List of Object) The list of all deploy keys across all projects of the GitLab instance. (see [below for nested schema](#nestedatt--deploy_keys))
40-
- `id` (String) The ID of this resource.
39+
- `deploy_keys` (Attributes List) The list of all deploy keys across all projects of the GitLab instance. (see [below for nested schema](#nestedatt--deploy_keys))
40+
- `id` (String) The ID of this datasource. In the format `<public>`.
4141

4242
<a id="nestedatt--deploy_keys"></a>
4343
### Nested Schema for `deploy_keys`
4444

4545
Read-Only:
4646

47-
- `created_at` (String)
48-
- `fingerprint` (String)
49-
- `id` (Number)
50-
- `key` (String)
51-
- `projects_with_write_access` (List of Object) (see [below for nested schema](#nestedobjatt--deploy_keys--projects_with_write_access))
52-
- `title` (String)
47+
- `created_at` (String) The creation date of the deploy key. In RFC3339 format.
48+
- `fingerprint` (String) The fingerprint of the deploy key.
49+
- `id` (Number) The ID of the deploy key.
50+
- `key` (String) The deploy key.
51+
- `projects_with_write_access` (Attributes List) The list of projects that the deploy key has write access to. (see [below for nested schema](#nestedatt--deploy_keys--projects_with_write_access))
52+
- `title` (String) The title of the deploy key.
5353

54-
<a id="nestedobjatt--deploy_keys--projects_with_write_access"></a>
54+
<a id="nestedatt--deploy_keys--projects_with_write_access"></a>
5555
### Nested Schema for `deploy_keys.projects_with_write_access`
5656

5757
Read-Only:
5858

59-
- `created_at` (String)
60-
- `description` (String)
61-
- `id` (Number)
62-
- `name` (String)
63-
- `name_with_namespace` (String)
64-
- `path` (String)
65-
- `path_with_namespace` (String)
59+
- `created_at` (String) The creation date of the project. In RFC3339 format.
60+
- `description` (String) The description of the project.
61+
- `id` (Number) The ID of the project.
62+
- `name` (String) The name of the project.
63+
- `name_with_namespace` (String) The name of the project with namespace.
64+
- `path` (String) The path of the project.
65+
- `path_with_namespace` (String) The path of the project with namespace.

docs/data-sources/project_branches.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -34,37 +34,37 @@ data "gitlab_project_branches" "example" {
3434

3535
### Read-Only
3636

37-
- `branches` (List of Object) The list of branches of the project, as defined below. (see [below for nested schema](#nestedatt--branches))
38-
- `id` (String) The ID of this resource.
37+
- `branches` (Attributes List) The list of branches of the project, as defined below. (see [below for nested schema](#nestedatt--branches))
38+
- `id` (String) The ID of this datasource. In the format `<project>`.
3939

4040
<a id="nestedatt--branches"></a>
4141
### Nested Schema for `branches`
4242

4343
Read-Only:
4444

45-
- `can_push` (Boolean)
46-
- `commit` (Set of Object) (see [below for nested schema](#nestedobjatt--branches--commit))
47-
- `default` (Boolean)
48-
- `developers_can_merge` (Boolean)
49-
- `developers_can_push` (Boolean)
50-
- `merged` (Boolean)
51-
- `name` (String)
52-
- `protected` (Boolean)
53-
- `web_url` (String)
54-
55-
<a id="nestedobjatt--branches--commit"></a>
45+
- `can_push` (Boolean) Bool, true if you can push to the branch.
46+
- `commit` (Attributes Set) The commit associated with the branch ref. (see [below for nested schema](#nestedatt--branches--commit))
47+
- `default` (Boolean) Bool, true if branch is the default branch for the project.
48+
- `developers_can_merge` (Boolean) Bool, true if developer level access allows to merge branch.
49+
- `developers_can_push` (Boolean) Bool, true if developer level access allows git push.
50+
- `merged` (Boolean) Bool, true if the branch has been merged into its parent.
51+
- `name` (String) The name of the branch.
52+
- `protected` (Boolean) Bool, true if branch has branch protection.
53+
- `web_url` (String) URL that can be used to find the branch in a browser.
54+
55+
<a id="nestedatt--branches--commit"></a>
5656
### Nested Schema for `branches.commit`
5757

5858
Read-Only:
5959

60-
- `author_email` (String)
61-
- `author_name` (String)
62-
- `authored_date` (String)
63-
- `committed_date` (String)
64-
- `committer_email` (String)
65-
- `committer_name` (String)
66-
- `id` (String)
67-
- `message` (String)
68-
- `parent_ids` (Set of String)
69-
- `short_id` (String)
70-
- `title` (String)
60+
- `author_email` (String) The email of the author.
61+
- `author_name` (String) The name of the author.
62+
- `authored_date` (String) The date which the commit was authored (format: yyyy-MM-ddTHH:mm:ssZ).
63+
- `committed_date` (String) The date at which the commit was pushed (format: yyyy-MM-ddTHH:mm:ssZ).
64+
- `committer_email` (String) The email of the user that committed.
65+
- `committer_name` (String) The name of the user that committed.
66+
- `id` (String) The unique id assigned to the commit by Gitlab.
67+
- `message` (String) The commit message
68+
- `parent_ids` (Set of String) The id of the parents of the commit
69+
- `short_id` (String) The short id assigned to the commit by Gitlab.
70+
- `title` (String) The title of the commit

docs/data-sources/project_hook.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
page_title: "gitlab_project_hook Data Source - terraform-provider-gitlab"
44
subcategory: ""
55
description: |-
6-
The gitlab_project_hook data source allows to retrieve details about a hook in a project.
6+
The gitlab_project_hook data source retrieves details about a hook in a project.
77
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/project_webhooks/#get-a-project-webhook
88
---
99

1010
# gitlab_project_hook (Data Source)
1111

12-
The `gitlab_project_hook` data source allows to retrieve details about a hook in a project.
12+
The `gitlab_project_hook` data source retrieves details about a hook in a project.
1313

1414
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/project_webhooks/#get-a-project-webhook)
1515

@@ -41,7 +41,7 @@ data "gitlab_project_hook" "example" {
4141
- `custom_webhook_template` (String) Set a custom webhook template.
4242
- `deployment_events` (Boolean) Invoke the hook for deployment events.
4343
- `enable_ssl_verification` (Boolean) Enable ssl verification when invoking the hook.
44-
- `id` (String) The ID of this resource.
44+
- `id` (String) The ID of this datasource. In the format `<project>:<hook-id>`.
4545
- `issues_events` (Boolean) Invoke the hook for issues events.
4646
- `job_events` (Boolean) Invoke the hook for job events.
4747
- `merge_requests_events` (Boolean) Invoke the hook for merge requests.
@@ -52,6 +52,6 @@ data "gitlab_project_hook" "example" {
5252
- `push_events_branch_filter` (String) Invoke the hook for push events on matching branches only.
5353
- `releases_events` (Boolean) Invoke the hook for releases events.
5454
- `tag_push_events` (Boolean) Invoke the hook for tag push events.
55-
- `token` (String) A token to present when invoking the hook. The token is not available for imported resources.
55+
- `token` (String, Sensitive, Deprecated) A token to present when invoking the hook. The token is not available in this datasource.
5656
- `url` (String) The url of the hook to invoke.
5757
- `wiki_page_events` (Boolean) Invoke the hook for wiki page events.

docs/data-sources/project_hooks.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -34,31 +34,31 @@ data "gitlab_project_hooks" "examples" {
3434

3535
### Read-Only
3636

37-
- `hooks` (List of Object) The list of hooks. (see [below for nested schema](#nestedatt--hooks))
38-
- `id` (String) The ID of this resource.
37+
- `hooks` (Attributes List) The list of hooks. (see [below for nested schema](#nestedatt--hooks))
38+
- `id` (String) The ID of this datasource. In the format `<project>`.
3939

4040
<a id="nestedatt--hooks"></a>
4141
### Nested Schema for `hooks`
4242

4343
Read-Only:
4444

45-
- `confidential_issues_events` (Boolean)
46-
- `confidential_note_events` (Boolean)
47-
- `custom_webhook_template` (String)
48-
- `deployment_events` (Boolean)
49-
- `enable_ssl_verification` (Boolean)
50-
- `hook_id` (Number)
51-
- `issues_events` (Boolean)
52-
- `job_events` (Boolean)
53-
- `merge_requests_events` (Boolean)
54-
- `note_events` (Boolean)
55-
- `pipeline_events` (Boolean)
56-
- `project` (String)
57-
- `project_id` (Number)
58-
- `push_events` (Boolean)
59-
- `push_events_branch_filter` (String)
60-
- `releases_events` (Boolean)
61-
- `tag_push_events` (Boolean)
62-
- `token` (String)
63-
- `url` (String)
64-
- `wiki_page_events` (Boolean)
45+
- `confidential_issues_events` (Boolean) Invoke the hook for confidential issues events.
46+
- `confidential_note_events` (Boolean) Invoke the hook for confidential notes events.
47+
- `custom_webhook_template` (String) Set a custom webhook template.
48+
- `deployment_events` (Boolean) Invoke the hook for deployment events.
49+
- `enable_ssl_verification` (Boolean) Enable ssl verification when invoking the hook.
50+
- `hook_id` (Number) The id of the project hook.
51+
- `issues_events` (Boolean) Invoke the hook for issues events.
52+
- `job_events` (Boolean) Invoke the hook for job events.
53+
- `merge_requests_events` (Boolean) Invoke the hook for merge requests.
54+
- `note_events` (Boolean) Invoke the hook for notes events.
55+
- `pipeline_events` (Boolean) Invoke the hook for pipeline events.
56+
- `project` (String) The name or id of the project to add the hook to.
57+
- `project_id` (Number) The id of the project for the hook.
58+
- `push_events` (Boolean) Invoke the hook for push events.
59+
- `push_events_branch_filter` (String) Invoke the hook for push events on matching branches only.
60+
- `releases_events` (Boolean) Invoke the hook for releases events.
61+
- `tag_push_events` (Boolean) Invoke the hook for tag push events.
62+
- `token` (String, Sensitive, Deprecated) A token to present when invoking the hook. The token is not available in this datasource.
63+
- `url` (String) The url of the hook to invoke.
64+
- `wiki_page_events` (Boolean) Invoke the hook for wiki page events.

docs/data-sources/project_membership.md

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,13 @@
33
page_title: "gitlab_project_membership Data Source - terraform-provider-gitlab"
44
subcategory: ""
55
description: |-
6-
The gitlab_project_membership data source allows to list and filter all members of a project specified by either its id or full path.
7-
-> Note exactly one of project_id or full_path must be provided.
6+
The gitlab_project_membership data source allows you to list and filter all members of a project.
87
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/members/#list-all-members-of-a-group-or-project
98
---
109

1110
# gitlab_project_membership (Data Source)
1211

13-
The `gitlab_project_membership` data source allows to list and filter all members of a project specified by either its id or full path.
14-
15-
-> **Note** exactly one of project_id or full_path must be provided.
12+
The `gitlab_project_membership` data source allows you to list and filter all members of a project.
1613

1714
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/members/#list-all-members-of-a-group-or-project)
1815

@@ -42,27 +39,28 @@ data "gitlab_project_membership" "example" {
4239

4340
### Optional
4441

45-
- `full_path` (String) The full path of the project.
42+
- `full_path` (String, Deprecated) The full path of the project.
4643
- `inherited` (Boolean) Return all project members including members through ancestor groups
47-
- `project_id` (Number) The ID of the project.
44+
- `project` (String) The ID or full path of the project.
45+
- `project_id` (Number, Deprecated) The ID of the project.
4846
- `query` (String) A query string to search for members
4947
- `user_ids` (Set of Number) List of user ids to filter members by
5048

5149
### Read-Only
5250

53-
- `id` (String) The ID of this resource.
54-
- `members` (List of Object) The list of project members. (see [below for nested schema](#nestedatt--members))
51+
- `id` (String) The ID of this datasource. In the format `<project:query-hash>` if query is set, otherwise `<project>`.
52+
- `members` (Attributes List) The list of project members. (see [below for nested schema](#nestedatt--members))
5553

5654
<a id="nestedatt--members"></a>
5755
### Nested Schema for `members`
5856

5957
Read-Only:
6058

61-
- `access_level` (String)
62-
- `avatar_url` (String)
63-
- `expires_at` (String)
64-
- `id` (Number)
65-
- `name` (String)
66-
- `state` (String)
67-
- `username` (String)
68-
- `web_url` (String)
59+
- `access_level` (String) The level of access to the group.
60+
- `avatar_url` (String) The avatar URL of the user.
61+
- `expires_at` (String) Expiration date for the group membership.
62+
- `id` (Number) The unique id assigned to the user by the gitlab server.
63+
- `name` (String) The name of the user.
64+
- `state` (String) Whether the user is active or blocked.
65+
- `username` (String) The username of the user.
66+
- `web_url` (String) User's website URL.

0 commit comments

Comments
 (0)