Skip to content

Commit 0632fb8

Browse files
Update docs for v18.5.0 release
1 parent 7a2681d commit 0632fb8

34 files changed

+270
-140
lines changed

CHANGELOG.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,26 @@
1+
## 18.5.0 (2025-10-14)
2+
3+
### FEATURES (2 changes)
4+
5+
- datasource/gitlab_project_approval_rules: [Add New Data Source for GitLab Project Approval Rules](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/93fe466255fcbf41bc19e1faf708bb9f3e704df6) by @markwork ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2624))
6+
- resource/gitlab_group_service_account: [Add support for custom timeouts to `gitlab_group_service_account`](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/1e57cac88865beed668edfefb8293a79d4d77036) by @PatrickRice ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2689))
7+
8+
### IMPROVEMENTS (2 changes)
9+
10+
- datasource/gitlab_projects: [Deprecate datasource gitlab_projects._links](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/55e58137) by @heidi.berry ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2744))
11+
- resource/gitlab_project: [Add project resource group default process mode](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/ed55f6f4974dc5ef1f68f6f341ed77eb690b0269) by @n.h.long.9697 ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2692))
12+
13+
### DOCUMENTATION (2 changes)
14+
15+
- [Add missing deprecation notices to some resources and datasources](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/2cd6b09d) by @heidi.berry ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2745))
16+
- [Ensure deprecation notices properly display in the docs](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/6c7f8b79) by @heidi.berry ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2743))
17+
18+
### BUG FIXES (3 changes)
19+
20+
- resource/gitlab_application_settings: [Fix mapping package_metadata_purl_types in update](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/b57143a3) by @elC0mpa ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2729))
21+
- resource/gitlab_project_membership: [`expires_at` now validates that the date is not in the past, which previously caused an API error](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/311bc16f3aee383284025ce7ffdb9a01fa30ec5b) by @elC0mpa ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2712))
22+
- resource/gitlab_project_membership,resource/gitlab_group_membership: [`member_role_id` will now be removed if not specified in the config, allowing users to revert to base roles](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/b503771e5f56d03645ffab646ea7e72ef3911a8a) by @elC0mpa ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2713))
23+
124
## 18.4.1 (2025-09-23)
225

326
### IMPROVEMENTS (1 change)
@@ -98,6 +121,11 @@
98121
- datasource/gitlab_user: [Add experimental support for `email_exact_match`, which will always return an exact match on the email. This will override the fuzzy matching of the GitLab search API when no users match the given email.](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/2dd44a088abaeda3494c24fd5f8b939dff1a8d73) by @ricardo.bartels ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2362))
99122
- multiple resources: [Add missing examples to resources](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/d853ffe687699c313bf421cdf595b415c821d3bb) by @heidi.berry ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2519))
100123

124+
### DOCUMENTATION (2 changes)
125+
126+
- [Add missing deprecation notices](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/2cd6b09d) ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2745))
127+
- [Ensure deprecation notices come out in the docs](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/6c7f8b79) ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2743))
128+
101129
### BUG FIXES (3 changes)
102130

103131
- resource/gitlab_branch: [Add warning to use lifecycle ignore_changes for gitlab_branch.ref](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/4e91cf3742610da549b943c6e60c52b96ec62a15) by @heidi.berry ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2542))
@@ -206,6 +234,11 @@ This release was tested against GitLab 17.10, 17.9, and 17.8 for both CE and EE
206234
- datasource/gitlab_users: [Add support for several new attributes.](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/fde7c9f221526fb1600548aafa0b748deba8d2e9) by @heidi.berry ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2361))
207235
- datasource/gitlab_project_environment: [Add `auto_stop_setting` as a read-only attribute](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/c8669f4ca7e59241f21badbd2be4d99001f9bdd3) by @jtymes ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2300))
208236

237+
### DOCUMENTATION (2 changes)
238+
239+
- [Add missing deprecation notices](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/2cd6b09d) ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2745))
240+
- [Ensure deprecation notices come out in the docs](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/6c7f8b79) ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2743))
241+
209242
### BUG FIXES (3 changes)
210243

211244
- resource/gitlab_value_stream_analytics: [Update `stages` from an unordered list to an ordered list since order matters in the API](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/7982745332ad8f4b90d1019e6273317e58326230) by @calee1 ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2339))
@@ -482,6 +515,11 @@ Note: As a security related change, this breaking change is allowed outside a ma
482515

483516
This release was tested against GitLab 17.1, 17.0, and 16.11 for both CE and EE
484517

518+
### DOCUMENTATION (2 changes)
519+
520+
- [Add missing deprecation notices](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/2cd6b09d) ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2745))
521+
- [Ensure deprecation notices come out in the docs](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/6c7f8b79) ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2743))
522+
485523
### BUG FIXES (3 changes)
486524

487525
- resource/gitlab_project_job_token_scopes: [Correct examples for resource project_job_token_scopes](gitlab-org/terraform-provider-gitlab@3027ed1e0861b405ef81f13b3e58fce5aff96ed2) by @heidi.berry ([merge request](gitlab-org/terraform-provider-gitlab!1968))

docs/data-sources/group.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ data "gitlab_group" "foo" {
4242
- `description` (String) The description of the group.
4343
- `extra_shared_runners_minutes_limit` (Number) Can be set by administrators only. Additional CI/CD minutes for this group.
4444
- `full_name` (String) The full name of the group.
45-
- `id` (String) The ID of this resource.
45+
- `id` (String) The ID of this datasource. In the format `<group-id>`.
4646
- `lfs_enabled` (Boolean) Boolean, is LFS enabled for projects in this group.
4747
- `membership_lock` (Boolean) Users cannot be added to projects in this group.
4848
- `name` (String) The name of this group.
@@ -52,8 +52,8 @@ data "gitlab_group" "foo" {
5252
- `request_access_enabled` (Boolean) Boolean, is request for access enabled to the group.
5353
- `runners_token` (String, Sensitive) The group level registration token to use during runner setup.
5454
- `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.
55-
- `shared_runners_setting` (String) Enable or disable shared runners for a groups subgroups and projects. Valid values are: `enabled`, `disabled_and_overridable`, `disabled_and_unoverridable`, `disabled_with_override`.
56-
- `shared_with_groups` (List of Object) Describes groups which have access shared to this group. (see [below for nested schema](#nestedatt--shared_with_groups))
55+
- `shared_runners_setting` (String) Enable or disable shared runners for a group's subgroups and projects. Valid values are: `enabled`, `disabled_and_overridable`, `disabled_and_unoverridable`, `disabled_with_override`.
56+
- `shared_with_groups` (Attributes List) Describes groups which have access shared to this group. (see [below for nested schema](#nestedatt--shared_with_groups))
5757
- `visibility_level` (String) Visibility level of the group. Possible values are `private`, `internal`, `public`.
5858
- `web_url` (String) Web URL of the group.
5959
- `wiki_access_level` (String) The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are `disabled`, `private`, `enabled`.
@@ -63,8 +63,8 @@ data "gitlab_group" "foo" {
6363

6464
Read-Only:
6565

66-
- `expires_at` (String)
67-
- `group_access_level` (Number)
68-
- `group_full_path` (String)
69-
- `group_id` (Number)
70-
- `group_name` (String)
66+
- `expires_at` (String) Share with group expiration date.
67+
- `group_access_level` (Number) The access_level permission level of the shared group.
68+
- `group_full_path` (String) The full path of the group shared with.
69+
- `group_id` (Number) The ID of the group shared with.
70+
- `group_name` (String) The name of the group shared with.

docs/data-sources/group_hook.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -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, Deprecated) A token to present when invoking the hook. The token is not available in this datasource.
57+
- `token` (String, Deprecated) A token to present when invoking the hook. The token is only available on resource creation, not in this datasource. It will always be blank. To be removed in 19.0.
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/group_hooks.md

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

1010
# gitlab_group_hooks (Data Source)
1111

12-
The `gitlab_group_hooks` data source allows to retrieve details about hooks in a group.
12+
The `gitlab_group_hooks` data source retrieves details about hooks in a group.
1313

1414
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/group_webhooks/#list-group-hooks)
1515

@@ -34,33 +34,33 @@ data "gitlab_group_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 data source. In the format `<group>`.
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-
- `emoji_events` (Boolean)
50-
- `enable_ssl_verification` (Boolean)
51-
- `group` (String)
52-
- `group_id` (Number)
53-
- `hook_id` (Number)
54-
- `issues_events` (Boolean)
55-
- `job_events` (Boolean)
56-
- `merge_requests_events` (Boolean)
57-
- `note_events` (Boolean)
58-
- `pipeline_events` (Boolean)
59-
- `push_events` (Boolean)
60-
- `push_events_branch_filter` (String)
61-
- `releases_events` (Boolean)
62-
- `subgroup_events` (Boolean)
63-
- `tag_push_events` (Boolean)
64-
- `token` (String)
65-
- `url` (String)
66-
- `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+
- `emoji_events` (Boolean) Invoke the hook for emoji events.
50+
- `enable_ssl_verification` (Boolean) Enable ssl verification when invoking the hook.
51+
- `group` (String) The ID or full path of the group.
52+
- `group_id` (Number) The id of the group for the hook.
53+
- `hook_id` (Number) The id of the group hook.
54+
- `issues_events` (Boolean) Invoke the hook for issues events.
55+
- `job_events` (Boolean) Invoke the hook for job events.
56+
- `merge_requests_events` (Boolean) Invoke the hook for merge requests.
57+
- `note_events` (Boolean) Invoke the hook for notes events.
58+
- `pipeline_events` (Boolean) Invoke the hook for pipeline events.
59+
- `push_events` (Boolean) Invoke the hook for push events.
60+
- `push_events_branch_filter` (String) Invoke the hook for push events on matching branches only.
61+
- `releases_events` (Boolean) Invoke the hook for releases events.
62+
- `subgroup_events` (Boolean) Invoke the hook for subgroup events.
63+
- `tag_push_events` (Boolean) Invoke the hook for tag push events.
64+
- `token` (String, Deprecated) A token to present when invoking the hook. The token is only available on resource creation, not in this datasource. It will always be blank. To be removed in 19.0.
65+
- `url` (String) The url of the hook to invoke.
66+
- `wiki_page_events` (Boolean) Invoke the hook for wiki page events.

docs/data-sources/group_subgroups.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -46,39 +46,39 @@ output "subgroups" {
4646

4747
### Read-Only
4848

49-
- `id` (String) The ID of this resource.
50-
- `subgroups` (List of Object) Subgroups of the parent group. (see [below for nested schema](#nestedatt--subgroups))
49+
- `id` (String) The ID of this datasource. In the format `<group-id>`.
50+
- `subgroups` (Attributes List) Subgroups of the parent group. (see [below for nested schema](#nestedatt--subgroups))
5151

5252
<a id="nestedatt--subgroups"></a>
5353
### Nested Schema for `subgroups`
5454

5555
Read-Only:
5656

57-
- `allowed_email_domains_list` (String)
58-
- `auto_devops_enabled` (Boolean)
59-
- `avatar_url` (String)
60-
- `created_at` (String)
61-
- `default_branch_protection` (Number)
62-
- `description` (String)
63-
- `emails_enabled` (Boolean)
64-
- `file_template_project_id` (Number)
65-
- `full_name` (String)
66-
- `full_path` (String)
67-
- `group_id` (Number)
68-
- `ip_restriction_ranges` (String)
69-
- `lfs_enabled` (Boolean)
70-
- `mentions_disabled` (Boolean)
71-
- `name` (String)
72-
- `parent_id` (Number)
73-
- `path` (String)
74-
- `project_creation_level` (String)
75-
- `request_access_enabled` (Boolean)
76-
- `require_two_factor_authentication` (Boolean)
77-
- `share_with_group_lock` (Boolean)
78-
- `shared_runners_setting` (String)
79-
- `statistics` (Map of String)
80-
- `subgroup_creation_level` (String)
81-
- `two_factor_grace_period` (Number)
82-
- `visibility` (String)
83-
- `web_url` (String)
84-
- `wiki_access_level` (String)
57+
- `allowed_email_domains_list` (String) A list of email address domains to allow group access.
58+
- `auto_devops_enabled` (Boolean) Default to Auto DevOps pipeline for all projects within this group.
59+
- `avatar_url` (String) The URL of the avatar image.
60+
- `created_at` (String) Group created at date.
61+
- `default_branch_protection` (Number) Whether developers and maintainers can push to the applicable default branch.
62+
- `description` (String) The description of the group.
63+
- `emails_enabled` (Boolean) Enable email notifications.
64+
- `file_template_project_id` (Number) The ID of the project that will be used for file templates.
65+
- `full_name` (String) The full name of the group.
66+
- `full_path` (String) The full path of the group.
67+
- `group_id` (Number) The ID of the group.
68+
- `ip_restriction_ranges` (String) A list of IP addresses or subnet masks to restrict group access.
69+
- `lfs_enabled` (Boolean) Is LFS enabled for projects in this group.
70+
- `mentions_disabled` (Boolean) Disable the capability of a group from getting mentioned.
71+
- `name` (String) The name of this group.
72+
- `parent_id` (Number) ID of the parent group.
73+
- `path` (String) The path of the group.
74+
- `project_creation_level` (String) Determine if developers can create projects in the group. Valid values are: `noone`, `owner`, `maintainer`, `developer`, `administrator`
75+
- `request_access_enabled` (Boolean) Is request for access enabled to the group.
76+
- `require_two_factor_authentication` (Boolean) Require all users in this group to setup Two-factor authentication.
77+
- `share_with_group_lock` (Boolean) Prevent sharing a project with another group within this group.
78+
- `shared_runners_setting` (String) Enable or disable shared runners for a group's subgroups and projects. Valid values are: `enabled`, `disabled_and_overridable`, `disabled_and_unoverridable`, `disabled_with_override`.
79+
- `statistics` (Map of String) Group statistics.
80+
- `subgroup_creation_level` (String) Allowed to create subgroups. Valid values are: `owner`, `maintainer`.
81+
- `two_factor_grace_period` (Number) Time before Two-factor authentication is enforced (in hours).
82+
- `visibility` (String) Limited by visibility `public`, `internal`, or `private`.
83+
- `web_url` (String) Web URL of the group.
84+
- `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/groups.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -44,27 +44,27 @@ data "gitlab_groups" "example-two" {
4444

4545
### Read-Only
4646

47-
- `groups` (List of Object) The list of groups. (see [below for nested schema](#nestedatt--groups))
48-
- `id` (String) The ID of this resource.
47+
- `groups` (Attributes List) The list of groups. (see [below for nested schema](#nestedatt--groups))
48+
- `id` (String) The ID of this datasource. In the format of a hash of the provided search attributes.
4949

5050
<a id="nestedatt--groups"></a>
5151
### Nested Schema for `groups`
5252

5353
Read-Only:
5454

55-
- `default_branch_protection` (Number)
56-
- `description` (String)
57-
- `full_name` (String)
58-
- `full_path` (String)
59-
- `group_id` (Number)
60-
- `lfs_enabled` (Boolean)
61-
- `name` (String)
62-
- `parent_id` (Number)
63-
- `path` (String)
64-
- `prevent_forking_outside_group` (Boolean)
65-
- `request_access_enabled` (Boolean)
66-
- `runners_token` (String)
67-
- `shared_runners_setting` (String)
68-
- `visibility_level` (String)
69-
- `web_url` (String)
70-
- `wiki_access_level` (String)
55+
- `default_branch_protection` (Number, Deprecated) Whether developers and maintainers can push to the applicable default branch. Will be removed in 19.0.
56+
- `description` (String) The description of the group.
57+
- `full_name` (String) The full name of the group.
58+
- `full_path` (String) The full path of the group.
59+
- `group_id` (Number) The ID of the group.
60+
- `lfs_enabled` (Boolean) Is LFS enabled for projects in this group.
61+
- `name` (String) The name of this group.
62+
- `parent_id` (Number) ID of the parent group.
63+
- `path` (String) The path of the group.
64+
- `prevent_forking_outside_group` (Boolean) When enabled, users can not fork projects from this group to external namespaces.
65+
- `request_access_enabled` (Boolean) Is request for access enabled to the group.
66+
- `runners_token` (String, Sensitive) The group level registration token to use during runner setup.
67+
- `shared_runners_setting` (String) Enable or disable shared runners for a group's subgroups and projects. Valid values are: `enabled`, `disabled_and_overridable`, `disabled_and_unoverridable`, `disabled_with_override`.
68+
- `visibility_level` (String) Visibility level of the group. Possible values are `private`, `internal`, `public`.
69+
- `web_url` (String) Web URL of the group.
70+
- `wiki_access_level` (String) The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are `disabled`, `private`, `enabled`.

0 commit comments

Comments
 (0)