Skip to content

Commit 60a2fbb

Browse files
Update docs for v17.11.0 release
1 parent 5826754 commit 60a2fbb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+203
-77
lines changed

CHANGELOG.md

+31
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,34 @@
1+
## 17.11.0 (2025-04-17)
2+
3+
This release was tested against GitLab 17.11, 17.10, and 17.9 for both CE and EE
4+
5+
### FEATURES (1 change)
6+
7+
- resource/gitlab_group_dependency_proxy: [Adds support for managing the docker hub Group Dependency Proxy](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/cf17cddf5da2310d621db6a7e20a3b9edff21d49) by @PatrickRice ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2418))
8+
9+
### IMPROVEMENTS (9 changes)
10+
11+
- resource/gitlab_project_job_token_scopes: [Add support for `Enabled`](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/08856986d33ea1eec8b93d972c4ede3726d7bbd4) by @qa-andreas-grub ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2422))
12+
- resource/gitlab_group_ldap_link: [Add support for `member_role_id` to support custom roles]() by @PatrickRice ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2430))
13+
- resource/gitlab_project: [Add support for ci_id_token_sub_claim_components](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/7c2ac93acfdbc199ca77421a8004310f52bb30d0) by @bakkerduncan ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2367))
14+
- resource/gitlab_project: [Add ci_delete_pipelines_in_seconds](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/59cd615f91f3fdd627a0e65026b5c6afb97154b9) by @ztzxt ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2391))
15+
- resource/gitlab_project: [Improved documentation for `squash_option`](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/3899c8601f13dc72e824801d94c231383aad3d8c) @heidi.berry ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2431))
16+
- resource/gitlab_integration_jira: [Added deprecation notice for `project_key`](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/e1f812e4361e1ca4f1baf1b8d610e4161569f13c) by @heidi.berry ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2426))
17+
- [Add support for new `planner` role to multiple membership resources](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/34d30d81f4a76ddd6089170d0530b87db5148650) by @heidi.berry ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2419))
18+
- [Update documentation URLs for multiple integration resources](gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/d9f459c07a26aaf46c40371ab69f2854049f962b) by @@bas.bremer ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2411))
19+
- [Add token descriptions to project, group, and personal access tokens](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/4b8dd0f9fba392c29a4d9a194562324499f48857) by @PatrickRice ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2416))
20+
21+
### BUG FIXES (8 changes)
22+
23+
- resource/gitlab_project_mirror: [Fixes an issue where `mirror_branch_regex` would cause a perpetual plan](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/255e947781a7096358601f3f79c3b201b75c8596) by @mness ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2424))
24+
- resource/gitlab_project_variable: [Fixed an issue where removing project variables outside of TF could break the state file](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/8fc8b3fa729322efceed0cacb7145d7947c09bec) by @jonathand2 ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2417))
25+
- resource/gitlab_group_variable: [Fixed an issue where removing group variables outside of TF could break the state file](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/8fc8b3fa729322efceed0cacb7145d7947c09bec) by @jonathand2 ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2417))
26+
- resource/gitlab_group: [Fix an issue where `membership_lock` was set to false if not specified in the config](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/2d4055b0169b184c4067babe80de9e4cce99c88e) by @PatrickRice ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2406))
27+
- resource/gitlab_group_issue_board: [Fix an issue with group issue board error handling that would cause the provider to panic](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/6a8e6ce3c09814e185eb9d2f3d15194154b1f47c) by @PatrickRice ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2409))
28+
- resource/gitlab_group_issue_board: [Added error handling to provide earlier error detection and messaging](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/53539a09ca3c9a60ad8b62b5a54c742ce78f6cf1) by @heidi.berry ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2429))
29+
- resource/gitlab_group_membership: [Fix an error where expires_at and member_role_id were not computed](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/bf0bc0cf79b0568d2531eafd32725a9259afbc88) by @PatrickRice ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2405))
30+
- resource/gitlab_instance_service_account: [Refactor a system panic that could happen when waiting for delete](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/5dfaddb1b4d738610fc9bc62e4f249fc124f5bd2) by @timofurrer ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2386))
31+
132
## 17.10.0 (2025-03-20)
233

334
This release was tested against GitLab 17.10, 17.9, and 17.8 for both CE and EE

docs/data-sources/branch.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ data "gitlab_branch" "foo" {
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.
4747
- `id` (String) The ID of this resource.
48-
- `merged` (Boolean) Bool, true if the branch has been merged into it's parent.
48+
- `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.)
5151

docs/data-sources/group.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ page_title: "gitlab_group Data Source - terraform-provider-gitlab"
44
subcategory: ""
55
description: |-
66
The gitlab_group data source allows details of a group to be retrieved by its id or full path.
7-
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/groups/#details-of-a-group
7+
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/groups/#get-a-single-group
88
---
99

1010
# gitlab_group (Data Source)
1111

1212
The `gitlab_group` data source allows details of a group to be retrieved by its id or full path.
1313

14-
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/groups/#details-of-a-group)
14+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/groups/#get-a-single-group)
1515

1616
## Example Usage
1717

docs/data-sources/group_hook.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ page_title: "gitlab_group_hook Data Source - terraform-provider-gitlab"
44
subcategory: ""
55
description: |-
66
The gitlab_group_hook data source allows to retrieve details about a hook in a group.
7-
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/groups/#get-group-hook
7+
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/group_webhooks/#get-a-group-hook
88
---
99

1010
# gitlab_group_hook (Data Source)
1111

1212
The `gitlab_group_hook` data source allows to retrieve details about a hook in a group.
1313

14-
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/groups/#get-group-hook)
14+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/group_webhooks/#get-a-group-hook)
1515

1616
## Example Usage
1717

docs/data-sources/group_hooks.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ page_title: "gitlab_group_hooks Data Source - terraform-provider-gitlab"
44
subcategory: ""
55
description: |-
66
The gitlab_group_hooks data source allows to retrieve details about hooks in a group.
7-
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/groups/#list-group-hooks
7+
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

1212
The `gitlab_group_hooks` data source allows to retrieve details about hooks in a group.
1313

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

1616
## Example Usage
1717

docs/data-sources/group_subgroups.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ page_title: "gitlab_group_subgroups Data Source - terraform-provider-gitlab"
44
subcategory: ""
55
description: |-
66
The gitlab_group_subgroups data source allows to get subgroups of a group.
7-
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/groups/#list-a-groups-subgroups
7+
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/groups/#list-subgroups
88
---
99

1010
# gitlab_group_subgroups (Data Source)
1111

1212
The `gitlab_group_subgroups` data source allows to get subgroups of a group.
1313

14-
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/groups/#list-a-groups-subgroups)
14+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/groups/#list-subgroups)
1515

1616
## Example Usage
1717

docs/data-sources/project.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ page_title: "gitlab_project Data Source - terraform-provider-gitlab"
44
subcategory: ""
55
description: |-
66
The gitlab_project data source allows details of a project to be retrieved by either its ID or its path with namespace.
7-
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/projects/#get-single-project
7+
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/projects/#get-a-single-project
88
---
99

1010
# gitlab_project (Data Source)
1111

1212
The `gitlab_project` data source allows details of a project to be retrieved by either its ID or its path with namespace.
1313

14-
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/projects/#get-single-project)
14+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/projects/#get-a-single-project)
1515

1616
## Example Usage
1717

@@ -33,6 +33,7 @@ data "gitlab_project" "example" {
3333
### Optional
3434

3535
- `ci_default_git_depth` (Number) Default number of revisions for shallow cloning.
36+
- `ci_id_token_sub_claim_components` (List of String) Fields included in the sub claim of the ID Token. Accepts an array starting with project_path. The array might also include ref_type and ref. Defaults to ["project_path", "ref_type", "ref"]. Introduced in GitLab 17.10.
3637
- `id` (String) The integer that uniquely identifies the project within the gitlab install.
3738
- `path_with_namespace` (String) The path of the repository with namespace.
3839
- `public_builds` (Boolean) If true, jobs can be viewed by non-project members.
@@ -50,6 +51,7 @@ data "gitlab_project" "example" {
5051
- `build_timeout` (Number) The maximum amount of time, in seconds, that a job can run.
5152
- `builds_access_level` (String) Set the builds access level. Valid values are `disabled`, `private`, `enabled`.
5253
- `ci_config_path` (String) CI config file path for the project.
54+
- `ci_delete_pipelines_in_seconds` (Number) Pipelines older than the configured time are deleted.
5355
- `ci_pipeline_variables_minimum_override_role` (String) The minimum role required to set variables when running pipelines and jobs. Introduced in GitLab 17.1. Valid values are `developer`, `maintainer`, `owner`, `no_one_allowed`
5456
- `ci_restrict_pipeline_cancellation_role` (String) The role required to cancel a pipeline or job. Premium and Ultimate only. Valid values are `developer`, `maintainer`, `no one`
5557
- `ci_separated_caches` (Boolean) Use separate caches for protected branches.

docs/data-sources/project_hook.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ page_title: "gitlab_project_hook Data Source - terraform-provider-gitlab"
44
subcategory: ""
55
description: |-
66
The gitlab_project_hook data source allows to retrieve details about a hook in a project.
7-
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/projects/#get-project-hook
7+
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

1212
The `gitlab_project_hook` data source allows to retrieve details about a hook in a project.
1313

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

1616
## Example Usage
1717

docs/data-sources/project_hooks.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ page_title: "gitlab_project_hooks Data Source - terraform-provider-gitlab"
44
subcategory: ""
55
description: |-
66
The gitlab_project_hooks data source allows to retrieve details about hooks in a project.
7-
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/projects/#list-project-hooks
7+
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/project_webhooks/#list-webhooks-for-a-project
88
---
99

1010
# gitlab_project_hooks (Data Source)
1111

1212
The `gitlab_project_hooks` data source allows to retrieve details about hooks in a project.
1313

14-
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/projects/#list-project-hooks)
14+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/project_webhooks/#list-webhooks-for-a-project)
1515

1616
## Example Usage
1717

docs/data-sources/projects.md

+2
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,9 @@ Read-Only:
9696
- `builds_access_level` (String)
9797
- `ci_config_path` (String)
9898
- `ci_default_git_depth` (Number)
99+
- `ci_delete_pipelines_in_seconds` (Number)
99100
- `ci_forward_deployment_enabled` (Boolean)
101+
- `ci_id_token_sub_claim_components` (List of String)
100102
- `ci_pipeline_variables_minimum_override_role` (String)
101103
- `ci_restrict_pipeline_cancellation_role` (String)
102104
- `container_expiration_policy` (List of Object) (see [below for nested schema](#nestedobjatt--projects--container_expiration_policy))

docs/data-sources/user.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: |-
66
The gitlab_user data source allows details of a user to be retrieved by either the user ID, username or email address.
77
-> Some attributes might not be returned depending on if you're an admin or not.
88
~> When using the email attribute, an exact match is not guaranteed. The most related match will be returned. The most related match will prioritize an exact match if one is available.
9-
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/users/#single-user
9+
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/users/#get-a-single-user
1010
---
1111

1212
# gitlab_user (Data Source)
@@ -17,7 +17,7 @@ The `gitlab_user` data source allows details of a user to be retrieved by either
1717

1818
~> When using the `email` attribute, an exact match is not guaranteed. The most related match will be returned. The most related match will prioritize an exact match if one is available.
1919

20-
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/users/#single-user)
20+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/users/#get-a-single-user)
2121

2222
## Example Usage
2323

docs/data-sources/user_sshkeys.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ page_title: "gitlab_user_sshkeys Data Source - terraform-provider-gitlab"
44
subcategory: ""
55
description: |-
66
The gitlab_user_sshkeys data source allows a list of SSH keys to be retrieved by either the user ID or username.
7-
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/users/#list-ssh-keys-for-user
7+
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/user_keys/#list-all-ssh-keys-for-a-user
88
---
99

1010
# gitlab_user_sshkeys (Data Source)
1111

1212
The `gitlab_user_sshkeys` data source allows a list of SSH keys to be retrieved by either the user ID or username.
1313

14-
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/users/#list-ssh-keys-for-user)
14+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/user_keys/#list-all-ssh-keys-for-a-user)
1515

1616

1717

docs/data-sources/users.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: |-
66
The gitlab_users data source allows details of multiple users to be retrieved given some optional filter criteria.
77
-> Some attributes might not be returned depending on if you're an admin or not.
88
-> Some available options require administrator privileges.
9-
Upstream API: GitLab REST API docs https://docs.gitlab.com/ce/api/users/#list-users
9+
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/users/#list-users
1010
---
1111

1212
# gitlab_users (Data Source)
@@ -17,7 +17,7 @@ The `gitlab_users` data source allows details of multiple users to be retrieved
1717

1818
-> Some available options require administrator privileges.
1919

20-
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ce/api/users/#list-users)
20+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/users/#list-users)
2121

2222
## Example Usage
2323

docs/development/CreatingANewResource.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -308,9 +308,9 @@ func (r *gitlabApplicationResource) Create(ctx context.Context, req resource.Cre
308308

309309
// configure GitLab API call
310310
options := &gitlab.CreateApplicationOptions{
311-
Name: gitlab.String(data.Name.ValueString()),
312-
RedirectURI: gitlab.String(data.RedirectURL.ValueString()),
313-
Scopes: gitlab.String(formatted_scopes),
311+
Name: gitlab.Ptr(data.Name.ValueString()),
312+
RedirectURI: gitlab.Ptr(data.RedirectURL.ValueString()),
313+
Scopes: gitlab.Ptr(formatted_scopes),
314314
}
315315

316316
if !data.Confidential.IsNull() {

docs/resources/branch.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ resource "gitlab_branch" "example" {
5151
- `developer_can_merge` (Boolean) Bool, true if developer level access allows to merge branch.
5252
- `developer_can_push` (Boolean) Bool, true if developer level access allows git push.
5353
- `id` (String) The ID of this resource.
54-
- `merged` (Boolean) Bool, true if the branch has been merged into it's parent.
54+
- `merged` (Boolean) Bool, true if the branch has been merged into its parent.
5555
- `protected` (Boolean) Bool, true if branch has branch protection.
5656
- `web_url` (String) The url of the created branch (https).
5757

docs/resources/group_access_token.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,8 @@ resource "gitlab_group_variable" "example" {
5252

5353
### Optional
5454

55-
- `access_level` (String) The access level for the group access token. Valid values are: `no one`, `minimal`, `guest`, `reporter`, `developer`, `maintainer`, `owner`. Default is `maintainer`.
55+
- `access_level` (String) The access level for the group access token. Valid values are: `no one`, `minimal`, `guest`, `planner`, `reporter`, `developer`, `maintainer`, `owner`. Default is `maintainer`.
56+
- `description` (String) The description of the group access token.
5657
- `expires_at` (String) When the token will expire, YYYY-MM-DD format.
5758
- `rotation_configuration` (Attributes) The configuration for when to rotate a token automatically. Will not rotate a token until `terraform apply` is run. (see [below for nested schema](#nestedatt--rotation_configuration))
5859

0 commit comments

Comments
 (0)