Skip to content

Commit 3a945b3

Browse files
gitlab-terraform-provider-botgitlab-terraform-provider-bot
committed
Update docs for v17.5.0 release
1 parent 9c3cf57 commit 3a945b3

17 files changed

+475
-22
lines changed

‎CHANGELOG.md

+27
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,30 @@
1+
## 17.5.0 (2024-10-17)
2+
3+
This release was tested against GitLab 17.5, 17.4, and 17.3 for both CE and EE
4+
5+
## FEATURES (3 changes)
6+
7+
- **New Resource** resource/gitlab_group_service_account: [Allows creating service accounts for a gitlab group](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/a1e1686636ee2d901344163bac22bc032ad52056) by @michal.szczepek ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2122))
8+
- **New Resource** resource/gitlab_group_service_account_token: [Allows creating service account tokens for a service account](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/a1e1686636ee2d901344163bac22bc032ad52056) by @michal.szczepek ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2122))
9+
- **New Datasource** data/gitlab_group_service_account: [Allows creating service accounts for a gitlab group](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/a1e1686636ee2d901344163bac22bc032ad52056) by @michal.szczepek ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2122))
10+
- **New Datasource** data/gitlab_group_provisioned_users: [Allows listing users provisioned by an Identity Provider](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/7daffab21eedd594746671a28becd20adba15f8c) by @nvh04121 ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2107))
11+
12+
## IMPROVEMENTS (9 changes)
13+
14+
- provider/gitlab: [Add support for `headers` to the provider to allow setting custom headers](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/72f1a49dddcaa9ad18a81a604066b9959f565bed) by @ruben.aleman ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2136))
15+
- resource/gitlab_application_settings: [Add support for 20 additional new fields](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/5a6321fb096c80be4319dc29cf2186f66163bd88) by @Jitsusama ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2110))
16+
- resource/gitlab_application_settings: [Add support for 23 (for a total of 43 in 17.5) additional new fields](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/4c07217976e4cebcbda7ee02bbda71a6696e9dac) by @Jitsusama ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2109))
17+
- resource/gitlab_project: [Support `allow_pipeline_trigger_approve_deployment`](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/2497fc45f72577292412a398302b508c357e9a5c) by @loozhengyuan ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2141))
18+
- resource/gitlab_project: [Support `model_experiments_access_level` and `model_registry_access_level`](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/aec6e45be6f6ee687062afa96b8b8b9347540bad) by @jeremad ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2125))
19+
- resource/gitlab_group: [Add support for specifying the default branch](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/b0983be7c8cec2651af5ce82cdbda1caf5e82c56) by @jae-sorcero ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2155))
20+
- resource/gitlab_group: [Add `no one` as a valid permissions when using `default_branch_protection_defaults`](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/bb0242b353c34907d88e47a418a51404228af7d9) by @jae-sorcero ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2147))
21+
- resource/gitlab_personal_access_token: [Add support for `rotation_configuration`](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/afa261c798635521fd660b04b1a6a7d9100113a7) by @ruben.aleman ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2143))
22+
- data/gitlab_pipeline_schedules: [Add `id` for each schedule found using the datasource](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/169c4daf5bf51e9f9176ea76c00e518117e0de4e) by @nicolas.boussuge.fintech ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2149))
23+
24+
## BUG FIXES (1 change)
25+
26+
- resource/gitlab_project: [Only apply `use_custom_template` during creation if the value is `true`. Fixes an issue where using `use_custom_template = false` would cause a 500 error](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/bf658535994f38b8dcf743e2827abe4e3e66e20b) by @PatrickRice ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2140))
27+
128
## 17.4.0 (2024-09-19)
229

330
This release was tested against GitLab 17.4, 17.3, and 17.2 for both CE and EE

‎docs/data-sources/group.md

+1
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ data "gitlab_group" "foo" {
3737

3838
### Read-Only
3939

40+
- `default_branch` (String) The default branch of the group.
4041
- `default_branch_protection` (Number) Whether developers and maintainers can push to the applicable default branch.
4142
- `description` (String) The description of the group.
4243
- `extra_shared_runners_minutes_limit` (Number) Can be set by administrators only. Additional CI/CD minutes for this group.

‎docs/data-sources/group_provisioned_users.md

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "gitlab_group_provisioned_users Data Source - terraform-provider-gitlab"
4+
subcategory: ""
5+
description: |-
6+
The gitlab_group_provisioned_users data source allows details of the provisioned users of a given group.
7+
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/groups.html#list-provisioned-users
8+
---
9+
10+
# gitlab_group_provisioned_users (Data Source)
11+
12+
The `gitlab_group_provisioned_users` data source allows details of the provisioned users of a given group.
13+
14+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/groups.html#list-provisioned-users)
15+
16+
17+
18+
<!-- schema generated by tfplugindocs -->
19+
## Schema
20+
21+
### Required
22+
23+
- `id` (String) The ID or URL-encoded path of the group.
24+
25+
### Optional
26+
27+
- `active` (Boolean) Return only active provisioned users.
28+
- `blocked` (Boolean) Return only blocked provisioned users.
29+
- `created_after` (String) Return only provisioned users created on or after the specified date. Expected in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
30+
- `created_before` (String) Return only provisioned users created on or before the specified date. Expected in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
31+
- `search` (String) The search query to filter the provisioned users.
32+
- `username` (String) The username of the provisioned user.
33+
34+
### Read-Only
35+
36+
- `provisioned_users` (Block List) The list of provisioned users. (see [below for nested schema](#nestedblock--provisioned_users))
37+
38+
<a id="nestedblock--provisioned_users"></a>
39+
### Nested Schema for `provisioned_users`
40+
41+
Read-Only:
42+
43+
- `avatar_url` (String) The avatar URL of the provisioned user.
44+
- `bio` (String) The bio of the provisioned user.
45+
- `bot` (Boolean) Whether the provisioned user is a bot.
46+
- `confirmed_at` (String) The confirmation date of the provisioned user.
47+
- `created_at` (String) The creation date of the provisioned user.
48+
- `email` (String) The email of the provisioned user.
49+
- `external` (Boolean) Whether the provisioned user is external.
50+
- `id` (String) The ID of the provisioned user.
51+
- `job_title` (String) The job title of the provisioned user.
52+
- `last_activity_on` (String) The last activity date of the provisioned user.
53+
- `last_sign_in_at` (String) The last sign-in date of the provisioned user.
54+
- `linkedin` (String) The LinkedIn ID of the provisioned user.
55+
- `location` (String) The location of the provisioned user.
56+
- `name` (String) The name of the provisioned user.
57+
- `organization` (String) The organization of the provisioned user.
58+
- `private_profile` (Boolean) Whether the provisioned user has a private profile.
59+
- `pronouns` (String) The pronouns of the provisioned user.
60+
- `public_email` (String) The public email of the provisioned user.
61+
- `skype` (String) The Skype ID of the provisioned user.
62+
- `state` (String) The state of the provisioned user.
63+
- `twitter` (String) The Twitter ID of the provisioned user.
64+
- `two_factor_enabled` (Boolean) Whether two-factor authentication is enabled for the provisioned user.
65+
- `username` (String) The username of the provisioned user.
66+
- `web_url` (String) The web URL of the provisioned user.
67+
- `website_url` (String) The website URL of the provisioned user.

‎docs/data-sources/group_service_account.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "gitlab_group_service_account Data Source - terraform-provider-gitlab"
4+
subcategory: ""
5+
description: |-
6+
The gitlab_group_service_account data source retrieves information about a gitlab service account for a group.
7+
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/group_service_accounts.html#list-service-account-users
8+
---
9+
10+
# gitlab_group_service_account (Data Source)
11+
12+
The `gitlab_group_service_account` data source retrieves information about a gitlab service account for a group.
13+
14+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/group_service_accounts.html#list-service-account-users)
15+
16+
17+
18+
<!-- schema generated by tfplugindocs -->
19+
## Schema
20+
21+
### Required
22+
23+
- `group` (String) The ID or URL-encoded path of the target group. Must be a top-level group.
24+
- `service_account_id` (String) The service account id.
25+
26+
### Optional
27+
28+
- `name` (String) The name of the user. If not specified, the default Service account user name is used.
29+
- `username` (String) The username of the user. If not specified, it's automatically generated.
30+
31+
### Read-Only
32+
33+
- `id` (String) The ID of this Terraform resource. In the format of `<group>:<service_account_id>`.

‎docs/data-sources/pipeline_schedules.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ data "gitlab_pipeline_schedules" "example" {
3838

3939
Required:
4040

41-
- `id` (String) The pipeline schedule id.
41+
- `id` (Number) The pipeline schedule id.
4242

4343
Optional:
4444

‎docs/data-sources/project.md

+3
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ data "gitlab_project" "example" {
3939

4040
### Read-Only
4141

42+
- `allow_pipeline_trigger_approve_deployment` (Boolean) Set whether or not a pipeline triggerer is allowed to approve deployments. Premium and Ultimate only.
4243
- `analytics_access_level` (String) Set the analytics access level. Valid values are `disabled`, `private`, `enabled`.
4344
- `archived` (Boolean) Whether the project is in read-only mode (archived).
4445
- `auto_cancel_pending_pipelines` (String) Auto-cancel pending pipelines. This isn’t a boolean, but enabled/disabled.
@@ -73,6 +74,8 @@ data "gitlab_project" "example" {
7374
- `merge_requests_access_level` (String) Set the merge requests access level. Valid values are `disabled`, `private`, `enabled`.
7475
- `merge_requests_enabled` (Boolean) Enable merge requests for the project.
7576
- `merge_trains_enabled` (Boolean) Enable or disable merge trains.
77+
- `model_experiments_access_level` (String) The visibility of machine learning model experiments.
78+
- `model_registry_access_level` (String) The visibility of machine learning model registry.
7679
- `monitor_access_level` (String) Set the monitor access level. Valid values are `disabled`, `private`, `enabled`.
7780
- `name` (String) The name of the project.
7881
- `namespace_id` (Number) The namespace (group or user) of the project. Defaults to your user.

‎docs/data-sources/project_merge_request.md

+103
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "gitlab_project_merge_request Data Source - terraform-provider-gitlab"
4+
subcategory: ""
5+
description: |-
6+
The gitlab_project_merge_request data source retrieves
7+
information about a single merge request related to a specific project.
8+
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/merge_requests.html#get-single-mr
9+
---
10+
11+
# gitlab_project_merge_request (Data Source)
12+
13+
The `gitlab_project_merge_request` data source retrieves
14+
information about a single merge request related to a specific project.
15+
16+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/merge_requests.html#get-single-mr)
17+
18+
## Example Usage
19+
20+
```terraform
21+
data "gitlab_project_merge_request" "by_project_id" {
22+
project = "123"
23+
iid = 456
24+
}
25+
26+
data "gitlab_project_merge_request" "by_project_name" {
27+
project = "company/group/project1"
28+
iid = 3
29+
}
30+
```
31+
32+
<!-- schema generated by tfplugindocs -->
33+
## Schema
34+
35+
### Required
36+
37+
- `iid` (Number) The unique project level ID of the merge request.
38+
- `project` (String) The ID or path of the project.
39+
40+
### Read-Only
41+
42+
- `assignee` (Attributes) First assignee of the merge request. (see [below for nested schema](#nestedatt--assignee))
43+
- `assignees` (Attributes List) Assignees of the merge request. (see [below for nested schema](#nestedatt--assignees))
44+
- `author` (Attributes) User who created this merge request. (see [below for nested schema](#nestedatt--author))
45+
- `blocking_discussions_resolved` (Boolean) Indicates if all discussions are resolved only if all are
46+
required before merge request can be merged.
47+
- `changes_count` (String) Number of changes made on the merge request. Empty when the
48+
merge request is created, and populates asynchronously.
49+
- `closed_at` (String) Timestamp of when the merge request was closed.
50+
- `closed_by` (Attributes) User who closed this merge request. (see [below for nested schema](#nestedatt--closed_by))
51+
- `created_at` (String) Timestamp of when the merge request was created.
52+
- `id` (Number) The unique instance level ID of the merge request.
53+
54+
<a id="nestedatt--assignee"></a>
55+
### Nested Schema for `assignee`
56+
57+
Read-Only:
58+
59+
- `avatar_url` (String) A link to the user's avatar image.
60+
- `id` (Number) The internal ID number of the user.
61+
- `name` (String) The name of the user.
62+
- `state` (String) The state of the user account.
63+
- `username` (String) The username of the user.
64+
- `web_url` (String) A link to the user's profile page.
65+
66+
67+
<a id="nestedatt--assignees"></a>
68+
### Nested Schema for `assignees`
69+
70+
Read-Only:
71+
72+
- `avatar_url` (String) A link to the user's avatar image.
73+
- `id` (Number) The internal ID number of the user.
74+
- `name` (String) The name of the user.
75+
- `state` (String) The state of the user account.
76+
- `username` (String) The username of the user.
77+
- `web_url` (String) A link to the user's profile page.
78+
79+
80+
<a id="nestedatt--author"></a>
81+
### Nested Schema for `author`
82+
83+
Read-Only:
84+
85+
- `avatar_url` (String) A link to the user's avatar image.
86+
- `id` (Number) The internal ID number of the user.
87+
- `name` (String) The name of the user.
88+
- `state` (String) The state of the user account.
89+
- `username` (String) The username of the user.
90+
- `web_url` (String) A link to the user's profile page.
91+
92+
93+
<a id="nestedatt--closed_by"></a>
94+
### Nested Schema for `closed_by`
95+
96+
Read-Only:
97+
98+
- `avatar_url` (String) A link to the user's avatar image.
99+
- `id` (Number) The internal ID number of the user.
100+
- `name` (String) The name of the user.
101+
- `state` (String) The state of the user account.
102+
- `username` (String) The username of the user.
103+
- `web_url` (String) A link to the user's profile page.

‎docs/data-sources/projects.md

+3
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ Read-Only:
8181

8282
- `_links` (Map of String)
8383
- `allow_merge_on_skipped_pipeline` (Boolean)
84+
- `allow_pipeline_trigger_approve_deployment` (Boolean)
8485
- `analytics_access_level` (String)
8586
- `approvals_before_merge` (Number)
8687
- `archived` (Boolean)
@@ -136,6 +137,8 @@ Read-Only:
136137
- `mirror_overwrites_diverged_branches` (Boolean)
137138
- `mirror_trigger_builds` (Boolean)
138139
- `mirror_user_id` (Number)
140+
- `model_experiments_access_level` (String)
141+
- `model_registry_access_level` (String)
139142
- `monitor_access_level` (String)
140143
- `name` (String)
141144
- `name_with_namespace` (String)

‎docs/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ resource "gitlab_project" "sample_group_project" {
8181
- `client_cert` (String) File path to client certificate when GitLab instance is behind company proxy. File must contain PEM encoded data.
8282
- `client_key` (String) File path to client key when GitLab instance is behind company proxy. File must contain PEM encoded data. Required when `client_cert` is set.
8383
- `early_auth_check` (Boolean) (Experimental) By default the provider does a dummy request to get the current user in order to verify that the provider configuration is correct and the GitLab API is reachable. Set this to `false` to skip this check. This may be useful if the GitLab instance does not yet exist and is created within the same terraform module. It may be sourced from the `GITLAB_EARLY_AUTH_CHECK`. This is an experimental feature and may change in the future. Please make sure to always keep backups of your state.
84+
- `headers` (Map of String) A map of headers to append to all API request to the GitLab instance.
8485
- `insecure` (Boolean) When set to true this disables SSL verification of the connection to the GitLab instance.
8586
- `retries` (Number) The number of retries to execute when receiving a 429 Rate Limit error. Each retry will exponentially back off.
8687
- `token` (String, Sensitive) The OAuth2 Token, Project, Group, Personal Access Token or CI Job Token used to connect to GitLab. The OAuth method is used in this provider for authentication (using Bearer authorization token). See https://docs.gitlab.com/ee/api/#authentication for details. It may be sourced from the `GITLAB_TOKEN` environment variable.

0 commit comments

Comments
 (0)