Skip to content

Commit 87a1b7a

Browse files
Update docs for v18.7.0 release
1 parent 2a38c37 commit 87a1b7a

Some content is hidden

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

51 files changed

+566
-94
lines changed

CHANGELOG.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,25 @@
1+
## 18.7.0 (2025-12-18)
2+
3+
### FEATURES (5 changes)
4+
5+
- resource/gitlab_user_avatar: [Add a new resource for managing avatars on project, group, and service account users](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/0fa637212011a84affdebc670635ed1640611ad1) by @mness ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2766))
6+
- data/gitlab_security_policy_document: [Add a datasource to generate policy file YAML using native HCL](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/b6c56dce8045af6c78fe4558040a0591a45d0eac) ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2811))
7+
- data/gitlab_group_service_account_access_tokens: [Add new data source for reading group service account access token metadata](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/6236eaa47aef6f0ca58456e15a610ab4b53562e0) by @vijeta004 ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2805))
8+
- data/gitlab_secure_file: [Add new data source for reading secure files](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/d39194ac07762e2b7492286ffcd68a174d1445f5) by @jack1902 ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2803))
9+
- data/gitlab_project_issue_label_events: [Add new data source for users to retrieve label events for an issue](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/ec7fd6b906f3cc4cc640b8d36e1ac0d397ca0b40) by @chanmickyyun ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2783))
10+
11+
### IMPROVEMENTS (3 changes)
12+
13+
- resource/gitlab_group: [Validate group name and stub at plan-time instead of apply-time](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/36ed196dad2392fecd542ad7f1a259aea519f65a) by @SinaMoghaddas ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2778))
14+
- data/gitlab_project: [Add support for merge_trains_skip_train_allowed](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/928e2780e204b108c011558bf675a0af1a5a9efa) ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2817))
15+
- resource/gitlab_member_role: [Add missing permissions](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/8244cac7a52536514cafe06c0c9e63ce684f009b) by @u.kilianpaquier ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2785))
16+
17+
### BUG FIXES (3 changes)
18+
19+
- resource/gitlab_branch: [Fixed an issue where updating branch name caused "Invalid resource ID format"](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/2912a2cd29f43e0e1a88fa5b8bcc2b6b6e7a3eee) ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2825))
20+
- resource/gitlab_group_service_account: [Fixed an issue where read error caused service accounts to be flagged as deleted](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/1ca9337d420ac99baefeb45a4697ea1949636912) ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2814))
21+
- docs: [Fixed broken or redirected documentation links](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/1c80354fa10ea590036ee44b0d55ef49098fff47) ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2827))
22+
123
## 18.6.1 (2025-11-21)
224

325
### BUG FIXES (1 change)

docs/data-sources/artifact_file.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ page_title: "gitlab_artifact_file Data Source - terraform-provider-gitlab"
44
subcategory: ""
55
description: |-
66
The gitlab_artifact_file data source allows downloading a single artifact file from a specific job in the latest successful pipeline for a given reference (branch, tag, or commit).
7-
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/job_artifacts.html#download-a-single-artifact-file-from-specific-tag-or-branch
7+
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/job_artifacts/#download-a-single-artifact-file-by-reference-name
88
---
99

1010
# gitlab_artifact_file (Data Source)
1111

1212
The `gitlab_artifact_file` data source allows downloading a single artifact file from a specific job in the latest successful pipeline for a given reference (branch, tag, or commit).
13-
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/job_artifacts.html#download-a-single-artifact-file-from-specific-tag-or-branch)
13+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/job_artifacts/#download-a-single-artifact-file-by-reference-name)
1414

1515
## Example Usage
1616

docs/data-sources/group_billable_member_memberships.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: |-
77
-> You must be an administrator!
88
~> When using the email attribute, an exact match is not guaranteed. The most related match will be returned. Starting with GitLab 16.6,
99
the most related match will prioritize an exact match if one is available.
10-
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/members/#list-memberships-for-a-billable-member-of-a-group
10+
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/group_members/#list-all-billable-members-of-a-group
1111
---
1212

1313
# gitlab_group_billable_member_memberships (Data Source)
@@ -19,7 +19,7 @@ The `gitlab_group_billable_member_memberships` data source allows (sub)group- an
1919
~> When using the `email` attribute, an exact match is not guaranteed. The most related match will be returned. Starting with GitLab 16.6,
2020
the most related match will prioritize an exact match if one is available.
2121

22-
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/members/#list-memberships-for-a-billable-member-of-a-group)
22+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/group_members/#list-all-billable-members-of-a-group)
2323

2424
## Example Usage
2525

@@ -48,7 +48,7 @@ data "gitlab_group_billable_member_memberships" "test_user_membership" {
4848

4949
Read-Only:
5050

51-
- `access_level` (String) Access-level of the member. For details see: https://docs.gitlab.com/api/access_requests/#valid-access-levels
51+
- `access_level` (String) Access-level of the member. For details see: https://docs.gitlab.com/user/permissions/#default-roles
5252
- `created_at` (String) Datetime when the membership was first added.
5353
- `expires_at` (String) Date when the membership will end.
5454
- `id` (Number) The id of the membership.

docs/data-sources/group_membership.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ page_title: "gitlab_group_membership Data Source - terraform-provider-gitlab"
44
subcategory: ""
55
description: |-
66
The gitlab_group_membership data source allows to list and filter all members of a group specified by either its id or full path.
7-
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/members/#list-all-members-of-a-group-or-project
7+
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/group_members/#list-all-members-of-a-group
88
---
99

1010
# gitlab_group_membership (Data Source)
1111

1212
The `gitlab_group_membership` data source allows to list and filter all members of a group specified by either its id or full path.
1313

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

1616
## Example Usage
1717

docs/data-sources/group_service_account.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ page_title: "gitlab_group_service_account Data Source - terraform-provider-gitla
44
subcategory: ""
55
description: |-
66
The gitlab_group_service_account data source retrieves information about a GitLab service account in a group.
7-
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/group_service_accounts/#list-service-account-users
7+
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/service_accounts/#list-all-group-service-accounts
88
---
99

1010
# gitlab_group_service_account (Data Source)
1111

1212
The `gitlab_group_service_account` data source retrieves information about a GitLab service account in a group.
1313

14-
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/group_service_accounts/#list-service-account-users)
14+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/service_accounts/#list-all-group-service-accounts)
1515

1616
## Example Usage
1717

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "gitlab_group_service_account_access_tokens Data Source - terraform-provider-gitlab"
4+
subcategory: ""
5+
description: |-
6+
The gitlab_group_service_account_access_tokens data source allows to retrieve all access tokens for a group service account.
7+
~> Note: The data source returns the token metadata only. The token value is not available.
8+
~> Permissions: You must have administrator access or be an Owner of the group to list the tokens of a service account.
9+
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/personal_access_tokens/#list-all-personal-access-tokens
10+
---
11+
12+
# gitlab_group_service_account_access_tokens (Data Source)
13+
14+
The `gitlab_group_service_account_access_tokens` data source allows to retrieve all access tokens for a group service account.
15+
16+
~> **Note:** The data source returns the token metadata only. The token value is not available.
17+
18+
~> **Permissions:** You must have administrator access or be an Owner of the group to list the tokens of a service account.
19+
20+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/personal_access_tokens/#list-all-personal-access-tokens)
21+
22+
## Example Usage
23+
24+
```terraform
25+
data "gitlab_group" "example" {
26+
id = "foo/bar/baz"
27+
}
28+
29+
# List all access tokens for a group service account
30+
data "gitlab_group_service_account_access_tokens" "example" {
31+
group = data.gitlab_group.example.id
32+
service_account_id = 123
33+
}
34+
35+
# Output example: Get the names of all tokens
36+
output "token_names" {
37+
value = [for token in data.gitlab_group_service_account_access_tokens.example.access_tokens : token.name]
38+
}
39+
40+
# Output example: Get only active tokens
41+
output "active_tokens" {
42+
value = [for token in data.gitlab_group_service_account_access_tokens.example.access_tokens : token if token.active]
43+
}
44+
```
45+
46+
<!-- schema generated by tfplugindocs -->
47+
## Schema
48+
49+
### Required
50+
51+
- `group` (String) The ID or URL-encoded path of the group containing the service account. Must be a top level group.
52+
- `service_account_id` (Number) The ID of the service account user.
53+
54+
### Read-Only
55+
56+
- `access_tokens` (List of Object) The list of access tokens for the service account. (see [below for nested schema](#nestedatt--access_tokens))
57+
- `id` (String) The ID of this Terraform resource. In the format of `<group>:<user_id>`.
58+
59+
<a id="nestedatt--access_tokens"></a>
60+
### Nested Schema for `access_tokens`
61+
62+
Read-Only:
63+
64+
- `active` (Boolean)
65+
- `created_at` (String)
66+
- `expires_at` (String)
67+
- `id` (String)
68+
- `name` (String)
69+
- `revoked` (Boolean)
70+
- `scopes` (Set of String)

docs/data-sources/group_variable.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ data "gitlab_group_variable" "bar" {
4545

4646
- `description` (String) The description of the variable.
4747
- `id` (String) The ID of this Terraform resource. In the format of `<group>:<key>:<environment_scope>`.
48-
- `masked` (Boolean) If set to `true`, the value of the variable will be hidden in job logs. The value must meet the [masking requirements](https://docs.gitlab.com/ci/variables/#masked-variables).
48+
- `masked` (Boolean) If set to `true`, the value of the variable will be hidden in job logs. The value must meet the [masking requirements](https://docs.gitlab.com/ci/variables/#mask-a-cicd-variable).
4949
- `protected` (Boolean) If set to `true`, the variable will be passed only to pipelines running on protected branches and tags
5050
- `raw` (Boolean) Whether the variable is treated as a raw string. Default: false. When true, variables in the value are not expanded.
5151
- `value` (String) The value of the variable.

docs/data-sources/instance_service_account.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ subcategory: ""
55
description: |-
66
The gitlab_instance_service_account data source retrieves information about a gitlab service account.
77
~> In order for a user to create a user account, they must have admin privileges at the instance level. This makes this feature unavailable on gitlab.com
8-
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/user_service_accounts/
8+
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/service_accounts/#instance-service-accounts
99
---
1010

1111
# gitlab_instance_service_account (Data Source)
@@ -14,7 +14,7 @@ The `gitlab_instance_service_account` data source retrieves information about a
1414

1515
~> In order for a user to create a user account, they must have admin privileges at the instance level. This makes this feature unavailable on `gitlab.com`
1616

17-
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/user_service_accounts/)
17+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/service_accounts/#instance-service-accounts)
1818

1919
## Example Usage
2020

docs/data-sources/project.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ data "gitlab_project" "example" {
7777
- `merge_requests_access_level` (String) Set the merge requests access level. Valid values are `disabled`, `private`, `enabled`.
7878
- `merge_requests_enabled` (Boolean, Deprecated) Enable merge requests for the project. Use `merge_requests_access_level` instead. This attribute will be removed in 19.0.
7979
- `merge_trains_enabled` (Boolean) Enable or disable merge trains.
80+
- `merge_trains_skip_train_allowed` (Boolean) Allows merge train merge requests to be merged without waiting for pipelines to finish.
8081
- `model_experiments_access_level` (String) The visibility of machine learning model experiments.
8182
- `model_registry_access_level` (String) The visibility of machine learning model registry.
8283
- `monitor_access_level` (String) Set the monitor access level. Valid values are `disabled`, `private`, `enabled`.
Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "gitlab_project_issue_label_events Data Source - terraform-provider-gitlab"
4+
subcategory: ""
5+
description: |-
6+
The gitlab_project_issue_label_events data source retrieves label events for a specific GitLab project issue.
7+
Upstream API: GitLab Resource Label Events API docs https://docs.gitlab.com/api/resource_label_events/
8+
---
9+
10+
# gitlab_project_issue_label_events (Data Source)
11+
12+
The `gitlab_project_issue_label_events` data source retrieves label events for a specific GitLab project issue.
13+
14+
**Upstream API**: [GitLab Resource Label Events API docs](https://docs.gitlab.com/api/resource_label_events/)
15+
16+
## Example Usage
17+
18+
```terraform
19+
data "gitlab_project_issue_label_events" "example" {
20+
project = "my-group/my-project"
21+
issue_iid = 42
22+
}
23+
```
24+
25+
<!-- schema generated by tfplugindocs -->
26+
## Schema
27+
28+
### Required
29+
30+
- `issue_iid` (Number) The internal ID of the issue.
31+
- `project` (String) The ID or full path of the project.
32+
33+
### Optional
34+
35+
- `pages_returned` (Number) Number of pages to return. Default is 1.
36+
37+
### Read-Only
38+
39+
- `events` (Attributes List) List of label events for the issue. (see [below for nested schema](#nestedatt--events))
40+
- `id` (String) The ID of this Terraform resource. In the format of `<project>:<issue_iid>`.
41+
42+
<a id="nestedatt--events"></a>
43+
### Nested Schema for `events`
44+
45+
Read-Only:
46+
47+
- `action` (String) The action performed on the label (add, remove).
48+
- `created_at` (String) The date and time when the label event was created.
49+
- `id` (Number) The ID of the label event.
50+
- `label` (Attributes) The label that was added or removed. (see [below for nested schema](#nestedatt--events--label))
51+
- `resource_id` (Number) The ID of the resource associated with the label event.
52+
- `resource_type` (String) The type of the resource associated with the label event.
53+
- `user` (Attributes) The user who performed the action. (see [below for nested schema](#nestedatt--events--user))
54+
55+
<a id="nestedatt--events--label"></a>
56+
### Nested Schema for `events.label`
57+
58+
Read-Only:
59+
60+
- `color` (String) The color of the label.
61+
- `description` (String) The description of the label.
62+
- `id` (Number) The ID of the label.
63+
- `name` (String) The name of the label.
64+
65+
66+
<a id="nestedatt--events--user"></a>
67+
### Nested Schema for `events.user`
68+
69+
Read-Only:
70+
71+
- `avatar_url` (String) The avatar URL of the user.
72+
- `id` (Number) The ID of the user.
73+
- `name` (String) The name of the user.
74+
- `state` (String) The state of the user.
75+
- `username` (String) The username of the user.
76+
- `web_url` (String) The web URL of the user.

0 commit comments

Comments
 (0)