Skip to content

Commit ed5d26e

Browse files
Update docs for v16.8.0 release
1 parent 196d436 commit ed5d26e

File tree

9 files changed

+137
-9
lines changed

9 files changed

+137
-9
lines changed

CHANGELOG.md

+24-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,27 @@
1-
## 16.7.0 (2023-12-21)
1+
## 16.8.0 (2024-01-18)
2+
3+
This release was tested against GitLab 16.6, 16.7, and 16.8 for both CE and EE
4+
5+
BREAKING CHANGE:
6+
7+
- gitlab_application_settings: Removed support for `delayed_group_deletion` and `delayed_project_deletion`, which haven't been supported since GitLab 16.0 ([!1799](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1799))
8+
9+
IMPROVEMENTS:
10+
11+
- **New Resource** `gitlab_global_level_notifications` allows managing global notifications for the user ([!1801](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1801))
12+
- resource/gitlab_project: Added support for the `timeouts` block, to allow configurable timeouts for creating projects ([]())
13+
- resource/gitlab_application_settings: Added support for `housekeeping_optimize_repository_period`, and updated the description of `housekeeping_enabled` to be more descriptive of what fields were required for a successful apply ([!1777](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1777))
14+
- datasource/gitlab_project: Added support for `shared_with_groups` which includes groups that are shared with the project ([!1795](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1795))
15+
- datasource/gitlab_group: Added support for `shared_with_groups` which includes groups that are shared with the group ([!1769](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1769))
16+
- datasource/gitlab_user: Added support for the `is_bot` attribute ([!1798](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1798))
17+
- datasource/gitlab_users: Added support for the `is_bot` attribute ([!1798](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1798))
18+
19+
BUG FIXES:
20+
21+
- resource/gitlab_pipeline_schedule_variable: Fixed an issue where deleting the pipeline associated to the variable outside of terraform would cause the resource to be stuck in an error state ([!1796](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1796))
22+
- resource/gitlab_project_hook: Fixed an issue where changing the URL of a webhook would delete the associated `token`. Changing the URL will now force a new webhook to be created ([!1794](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1794))
23+
24+
## 16.7.0 (2024-01-08)
225

326
This release was tested against GitLab 16.5, 16.6, and 16.7 for both CE and EE
427

docs/data-sources/group.md

+12
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,18 @@ data "gitlab_group" "foo" {
5252
- `runners_token` (String, Sensitive) The group level registration token to use during runner setup.
5353
- `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.
5454
- `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`.
55+
- `shared_with_groups` (List of Object) Describes groups which have access shared to this group. (see [below for nested schema](#nestedatt--shared_with_groups))
5556
- `visibility_level` (String) Visibility level of the group. Possible values are `private`, `internal`, `public`.
5657
- `web_url` (String) Web URL of the group.
5758
- `wiki_access_level` (String) The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are `disabled`, `private`, `enabled`.
59+
60+
<a id="nestedatt--shared_with_groups"></a>
61+
### Nested Schema for `shared_with_groups`
62+
63+
Read-Only:
64+
65+
- `expires_at` (String)
66+
- `group_access_level` (Number)
67+
- `group_full_path` (String)
68+
- `group_id` (Number)
69+
- `group_name` (String)

docs/data-sources/project.md

+12
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ data "gitlab_project" "example" {
8989
- `restrict_user_defined_variables` (Boolean) Allow only users with the Maintainer role to pass user-defined variables when triggering a pipeline.
9090
- `runners_token` (String, Sensitive) Registration token to use during runner setup.
9191
- `security_and_compliance_access_level` (String) Set the security and compliance access level. Valid values are `disabled`, `private`, `enabled`.
92+
- `shared_with_groups` (List of Object) Describes groups which have access shared to this project. (see [below for nested schema](#nestedatt--shared_with_groups))
9293
- `snippets_access_level` (String) Set the snippets access level. Valid values are `disabled`, `private`, `enabled`.
9394
- `snippets_enabled` (Boolean) Enable snippets for the project.
9495
- `squash_commit_template` (String) Template used to create squash commit message in merge requests. (Introduced in GitLab 14.6.)
@@ -131,3 +132,14 @@ Read-Only:
131132
- `member_check` (Boolean)
132133
- `prevent_secrets` (Boolean)
133134
- `reject_unsigned_commits` (Boolean)
135+
136+
137+
<a id="nestedatt--shared_with_groups"></a>
138+
### Nested Schema for `shared_with_groups`
139+
140+
Read-Only:
141+
142+
- `group_access_level` (Number)
143+
- `group_full_path` (String)
144+
- `group_id` (Number)
145+
- `group_name` (String)

docs/data-sources/user.md

+1
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ data "gitlab_user" "example-two" {
5959
- `external` (Boolean) Whether the user is external.
6060
- `id` (String) The ID of this resource.
6161
- `is_admin` (Boolean) Whether the user is an admin.
62+
- `is_bot` (Boolean) Whether the user is a bot.
6263
- `last_sign_in_at` (String) Last user's sign-in date.
6364
- `linkedin` (String) LinkedIn profile of the user.
6465
- `location` (String) The location of the user.

docs/data-sources/users.md

+1
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ Read-Only:
7070
- `external` (Boolean)
7171
- `id` (Number)
7272
- `is_admin` (Boolean)
73+
- `is_bot` (Boolean)
7374
- `last_sign_in_at` (String)
7475
- `linkedin` (String)
7576
- `location` (String)

docs/resources/application_settings.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -88,10 +88,8 @@ resource "gitlab_application_settings" "this" {
8888
- `default_project_visibility` (String) What visibility level new projects receive. Can take private, internal and public as a parameter.
8989
- `default_projects_limit` (Number) Project limit per user.
9090
- `default_snippet_visibility` (String) What visibility level new snippets receive. Can take private, internal and public as a parameter.
91-
- `delayed_group_deletion` (Boolean) Enable delayed group deletion. Introduced in GitLab 15.0. From GitLab 15.1, disables and locks the group-level setting for delayed protect deletion when set to false.
92-
- `delayed_project_deletion` (Boolean) Enable delayed project deletion by default in new groups. From GitLab 15.1, can only be enabled when delayed_group_deletion is true.
9391
- `delete_inactive_projects` (Boolean) Enable inactive project deletion feature. Introduced in GitLab 14.10. Became operational in GitLab 15.0 (with feature flag inactive_projects_deletion).
94-
- `deletion_adjourned_period` (Number) The number of days to wait before deleting a project or group that is marked for deletion. Value must be between 1 and 90. From GitLab 15.1, a hook on deletion_adjourned_period sets the period to 1 on every update, and sets both delayed_project_deletion and delayed_group_deletion to false if the period is 0.
92+
- `deletion_adjourned_period` (Number) The number of days to wait before deleting a project or group that is marked for deletion. Value must be between 1 and 90.
9593
- `diff_max_files` (Number) Maximum files in a diff.
9694
- `diff_max_lines` (Number) Maximum lines in a diff.
9795
- `diff_max_patch_bytes` (Number) Maximum diff patch size, in bytes.
@@ -161,10 +159,13 @@ resource "gitlab_application_settings" "this" {
161159
- `help_text` (String) GitLab server administrator information.
162160
- `hide_third_party_offers` (Boolean) Do not display offers from third parties in GitLab.
163161
- `home_page_url` (String) Redirect to this URL when not logged in.
164-
- `housekeeping_enabled` (Boolean) (If enabled, requires: housekeeping_bitmaps_enabled, housekeeping_full_repack_period, housekeeping_gc_period, and housekeeping_incremental_repack_period) Enable or disable Git housekeeping.
165-
- `housekeeping_full_repack_period` (Number) Number of Git pushes after which an incremental git repack is run.
166-
- `housekeeping_gc_period` (Number) Number of Git pushes after which git gc is run.
167-
- `housekeeping_incremental_repack_period` (Number) Number of Git pushes after which an incremental git repack is run.
162+
- `housekeeping_enabled` (Boolean) Enable or disable Git housekeeping.
163+
If enabled, requires either housekeeping_optimize_repository_period OR housekeeping_bitmaps_enabled, housekeeping_full_repack_period, housekeeping_gc_period, and housekeeping_incremental_repack_period.
164+
Options housekeeping_bitmaps_enabled, housekeeping_full_repack_period, housekeeping_gc_period, and housekeeping_incremental_repack_period are deprecated. Use housekeeping_optimize_repository_period instead.
165+
- `housekeeping_full_repack_period` (Number, Deprecated) Number of Git pushes after which an incremental git repack is run.
166+
- `housekeeping_gc_period` (Number, Deprecated) Number of Git pushes after which git gc is run.
167+
- `housekeeping_incremental_repack_period` (Number, Deprecated) Number of Git pushes after which an incremental git repack is run.
168+
- `housekeeping_optimize_repository_period` (Number) Number of Git pushes after which an incremental git repack is run.
168169
- `html_emails_enabled` (Boolean) Enable HTML emails.
169170
- `import_sources` (List of String) Sources to allow project import from. Valid values are: `github`, `bitbucket`, `bitbucket_server`, `fogbugz`, `git`, `gitlab_project`, `gitea`, `manifest`
170171
- `in_product_marketing_emails_enabled` (Boolean) Enable in-product marketing emails.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "gitlab_global_level_notifications Resource - terraform-provider-gitlab"
4+
subcategory: ""
5+
description: |-
6+
The gitlab_global_level_notifications resource allows to manage global notifications.
7+
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/notification_settings.html#group--project-level-notification-settings
8+
---
9+
10+
# gitlab_global_level_notifications (Resource)
11+
12+
The `gitlab_global_level_notifications` resource allows to manage global notifications.
13+
14+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/notification_settings.html#group--project-level-notification-settings)
15+
16+
## Example Usage
17+
18+
```terraform
19+
resource "gitlab_global_level_notifications" "foo" {
20+
level = "watch"
21+
}
22+
23+
# Create Custom global level notification
24+
resource "gitlab_global_level_notifications" "foo" {
25+
level = "custom"
26+
new_merge_request = true
27+
}
28+
```
29+
30+
<!-- schema generated by tfplugindocs -->
31+
## Schema
32+
33+
### Optional
34+
35+
- `close_issue` (Boolean) Enable notifications for closed issues. Can only be used when `level` is `custom`.
36+
- `close_merge_request` (Boolean) Enable notifications for closed merge requests. Can only be used when `level` is `custom`.
37+
- `failed_pipeline` (Boolean) Enable notifications for failed pipelines. Can only be used when `level` is `custom`.
38+
- `fixed_pipeline` (Boolean) Enable notifications for fixed pipelines. Can only be used when `level` is `custom`.
39+
- `issue_due` (Boolean) Enable notifications for due issues. Can only be used when `level` is `custom`.
40+
- `level` (String) The level of the notification. Valid values are: `disabled`, `participating`, `watch`, `global`, `mention`, `custom`.
41+
- `merge_merge_request` (Boolean) Enable notifications for merged merge requests. Can only be used when `level` is `custom`.
42+
- `merge_when_pipeline_succeeds` (Boolean) Enable notifications for merged merge requests when the pipeline succeeds. Can only be used when `level` is `custom`.
43+
- `moved_project` (Boolean) Enable notifications for moved projects. Can only be used when `level` is `custom`.
44+
- `new_issue` (Boolean) Enable notifications for new issues. Can only be used when `level` is `custom`.
45+
- `new_merge_request` (Boolean) Enable notifications for new merge requests. Can only be used when `level` is `custom`.
46+
- `new_note` (Boolean) Enable notifications for new notes on merge requests. Can only be used when `level` is `custom`.
47+
- `push_to_merge_request` (Boolean) Enable notifications for push to merge request branches. Can only be used when `level` is `custom`.
48+
- `reassign_issue` (Boolean) Enable notifications for issue reassignments. Can only be used when `level` is `custom`.
49+
- `reassign_merge_request` (Boolean) Enable notifications for merge request reassignments. Can only be used when `level` is `custom`.
50+
- `reopen_issue` (Boolean) Enable notifications for reopened issues. Can only be used when `level` is `custom`.
51+
- `reopen_merge_request` (Boolean) Enable notifications for reopened merge requests. Can only be used when `level` is `custom`.
52+
- `success_pipeline` (Boolean) Enable notifications for successful pipelines. Can only be used when `level` is `custom`.
53+
54+
### Read-Only
55+
56+
- `id` (String) The ID of the resource.This is a static value named gitlab
57+
58+
## Import
59+
60+
Import is supported using the following syntax:
61+
62+
```shell
63+
# Note: You can import a global notification state using "gitlab" as the ID.
64+
# The ID will always be gitlab, because the global notificatio only exists
65+
# once per user
66+
67+
terraform import gitlab_global_level_notifications.example gitlab
68+
```

docs/resources/project.md

+10
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,7 @@ This attribute is only used during resource creation, thus changes are suppresse
223223
- `tags` (Set of String) The list of tags for a project; put array of tags, that should be finally assigned to a project. Use topics instead.
224224
- `template_name` (String) When used without use_custom_template, name of a built-in project template. When used with use_custom_template, name of a custom project template. This option is mutually exclusive with `template_project_id`.
225225
- `template_project_id` (Number) When used with use_custom_template, project ID of a custom project template. This is preferable to using template_name since template_name may be ambiguous (enterprise edition). This option is mutually exclusive with `template_name`. See `gitlab_group_project_file_template` to set a project as a template project. If a project has not been set as a template, using it here will result in an error.
226+
- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))
226227
- `topics` (Set of String) The list of topics for the project.
227228
- `use_custom_template` (Boolean) Use either custom instance or group (with group_with_project_templates_id) project template (enterprise edition).
228229
~> When using a custom template, [Group Tokens won't work](https://docs.gitlab.com/15.7/ee/user/project/settings/import_export_troubleshooting.html#import-using-the-rest-api-fails-when-using-a-group-access-token). You must use a real user's Personal Access Token.
@@ -276,6 +277,15 @@ Optional:
276277
- `prevent_secrets` (Boolean) GitLab will reject any files that are likely to contain secrets.
277278
- `reject_unsigned_commits` (Boolean) Reject commit when it’s not signed through GPG.
278279

280+
281+
<a id="nestedblock--timeouts"></a>
282+
### Nested Schema for `timeouts`
283+
284+
Optional:
285+
286+
- `create` (String)
287+
- `delete` (String)
288+
279289
## Import
280290

281291
Import is supported using the following syntax:

docs/resources/project_hook.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ resource "gitlab_project_hook" "example" {
2929
### Required
3030

3131
- `project` (String) The name or id of the project to add the hook to.
32-
- `url` (String) The url of the hook to invoke.
32+
- `url` (String) The url of the hook to invoke. Forces re-creation to preserve `token`.
3333

3434
### Optional
3535

0 commit comments

Comments
 (0)