Update docs for v17.1.0 release

gitlab-terraform-provider-bot · gitlab-terraform-provider-bot · commit c56575b6e337 · 2024-06-20T21:42:29.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,27 @@
-## 17.0.0 (2024-06-07)
+
+## 17.1.0 (2024-06-20)
+
+This release was tested against GitLab 17.1, 17.0, and 16.11 for both CE and EE
+
+### BUG FIXES (3 changes)
+
+- 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)) 
+- resource/gitlab_group_access_token: [Fix an issue where using access tokens with a `time` provider caused segfaults](gitlab-org/terraform-provider-gitlab@de3b98c0881a8aa8a57ca9ea2ac735230b56f8c2) by @PatrickRice ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1999))
+- resource/gitlab_project_access_token: [Fix an issue where using access tokens with a `time` provider caused segfaults](gitlab-org/terraform-provider-gitlab@de3b98c0881a8aa8a57ca9ea2ac735230b56f8c2) by @PatrickRice ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1999))
+
+### IMPROVEMENTS (8 changes)
+
+- **New Resource** resource/gitlab_telegram_integration: [Implement Telegram Integration](gitlab-org/terraform-provider-gitlab@bc5eb7cf0138296aedb6f2559166a95f3f56bf32) by @alxrem ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1963))
+- resource/gitlab_group_saml_link: [Add ability to set custom roles on group SAML links](gitlab-org/terraform-provider-gitlab1cd431c8238fc690e04e9625951208693977e2c0) by @heidi.berry ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1949))
+- resource/gitlab_integration_slack:  [Add confidential_note_channel to slack integration](gitlab-org/terraform-provider-gitlab@38c49916a0d21151a59de518ca103b1fca3c5d6d) by @0oMarko0 ([merge request](gitlab-org/terraform-provider-gitlab!1988)) 
+- resource/gitlab_personal_access_token:  [Implement manage_runner access token scope](gitlab-org/terraform-provider-gitlab@a5a1c711d0d086a51dfd92fcc751814182e526b8) ([merge request](gitlab-org/terraform-provider-gitlab!1986)) 
+- resource/gitlab_personal_access_token:  [Mark `expires_at` attribute as optional](gitlab-org/terraform-provider-gitlab@7be1aa7f6948552eb2e16331b80c83e3f26eb971) by @erezo9 ([merge request](gitlab-org/terraform-provider-gitlab!1983))
+- resource/gitlab_group_access_token: [Fixed several documentation issues with access token resources](gitlab-org/terraform-provider-gitlab@738a1ffb41ad7cfaffa205d0c31f827d9f4e59e8) by @theipster ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2004))
+- resource/gitlab_project_access_token: [Fixed several documentation issues with access token resources](gitlab-org/terraform-provider-gitlab@738a1ffb41ad7cfaffa205d0c31f827d9f4e59e8) by @theipster ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2004))
+- resource/gitlab_project: [Update `initialize_with_readme` to add border case documentation](gitlab-org/terraform-provider-gitlab@247453b3e45362c4ef91fa9f537d6de7cf49cbfc) by @PatrickRice ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1989))
+
+
+## 17.0.1 (2024-06-07)
 
 This release was tested against GitLab 17.0, 16.11, and 16.10 for both CE and EE
 
diff --git a/docs/resources/group_access_token.md b/docs/resources/group_access_token.md
@@ -3,7 +3,7 @@
 page_title: "gitlab_group_access_token Resource - terraform-provider-gitlab"
 subcategory: ""
 description: |-
-  The gitlab_group_access_tokenresource allows to manage the lifecycle of a group access token.
+  The gitlab_group_access_token resource allows to manage the lifecycle of a group access token.
   ~> Observability scopes are in beta and may not work on all instances. See more details in the documentation https://docs.gitlab.com/ee/operations/tracing.html
   ~> Use rotation_configuration to automatically rotate tokens instead of using timestamp() as timestamp will cause changes with every plan. terraform apply must still be run to rotate the token.
   ~> Due to Automatic reuse detection https://docs.gitlab.com/ee/api/group_access_tokens.html#automatic-reuse-detection it's possible that a new Group Access Token will immediately be revoked. Check if an old process using the old token is running if this happens.
@@ -12,7 +12,7 @@ description: |-
 
 # gitlab_group_access_token (Resource)
 
-The `gitlab_group_access_token`resource allows to manage the lifecycle of a group access token.
+The `gitlab_group_access_token` resource allows to manage the lifecycle of a group access token.
 
 ~> Observability scopes are in beta and may not work on all instances. See more details in [the documentation](https://docs.gitlab.com/ee/operations/tracing.html)
 
@@ -48,7 +48,7 @@ resource "gitlab_group_variable" "example" {
 
 - `group` (String) The ID or full path of the group.
 - `name` (String) The name of the group access token.
-- `scopes` (Set of String) The scopes of the group access token. Valid values are: `api`, `read_api`, `read_user`, `k8s_proxy`, `read_registry`, `write_registry`, `read_repository`, `write_repository`, `create_runner`, `ai_features`, `k8s_proxy`, `read_observability`, `write_observability`
+- `scopes` (Set of String) The scopes of the group access token. Valid values are: `api`, `read_api`, `read_registry`, `write_registry`, `read_repository`, `write_repository`, `create_runner`, `manage_runner`, `ai_features`, `k8s_proxy`, `read_observability`, `write_observability`
 
 ### Optional
 
diff --git a/docs/resources/group_saml_link.md b/docs/resources/group_saml_link.md
@@ -16,11 +16,20 @@ The `gitlab_group_saml_link` resource allows to manage the lifecycle of an SAML
 ## Example Usage
 
 ```terraform
+# Basic example
 resource "gitlab_group_saml_link" "test" {
   group           = "12345"
   access_level    = "developer"
   saml_group_name = "samlgroupname1"
 }
+
+# Example using a Custom Role (Ultimate only)
+resource "gitlab_group_saml_link" "test_custom_role" {
+  group           = "12345"
+  access_level    = "developer"
+  saml_group_name = "samlgroupname1"
+  member_role_id  = 123
+}
 ```
 
 <!-- schema generated by tfplugindocs -->
@@ -32,6 +41,10 @@ resource "gitlab_group_saml_link" "test" {
 - `group` (String) The ID or path of the group to add the SAML Group Link to.
 - `saml_group_name` (String) The name of the SAML group.
 
+### Optional
+
+- `member_role_id` (Number) The ID of a custom member role. Only available for Ultimate instances.
+
 ### Read-Only
 
 - `id` (String) The ID of this resource.
diff --git a/docs/resources/integration_slack.md b/docs/resources/integration_slack.md
@@ -44,6 +44,7 @@ resource "gitlab_integration_slack" "slack" {
 - `branches_to_be_notified` (String) Branches to send notifications for. Valid options are "all", "default", "protected", and "default_and_protected".
 - `confidential_issue_channel` (String) The name of the channel to receive confidential issue events notifications.
 - `confidential_issues_events` (Boolean) Enable notifications for confidential issues events.
+- `confidential_note_channel` (String) The name of the channel to receive confidential note events notifications.
 - `confidential_note_events` (Boolean) Enable notifications for confidential note events.
 - `issue_channel` (String) The name of the channel to receive issue events notifications.
 - `issues_events` (Boolean) Enable notifications for issues events.
diff --git a/docs/resources/integration_telegram.md b/docs/resources/integration_telegram.md
@@ -0,0 +1,77 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "gitlab_integration_telegram Resource - terraform-provider-gitlab"
+subcategory: ""
+description: |-
+  The gitlab_integration_telegram resource allows to manage the lifecycle of a project integration with Telegram.
+  Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/integrations.html#telegram
+---
+
+# gitlab_integration_telegram (Resource)
+
+The `gitlab_integration_telegram` resource allows to manage the lifecycle of a project integration with Telegram.
+
+**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/integrations.html#telegram)
+
+## Example Usage
+
+```terraform
+resource "gitlab_project" "awesome_project" {
+  name             = "awesome_project"
+  description      = "My awesome project."
+  visibility_level = "public"
+}
+
+resource "gitlab_integration_telegram" "default" {
+  token = "123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11"
+  room  = "-1000000000000000"
+
+  notify_only_broken_pipelines = false
+  branches_to_be_notified      = "all"
+  push_events                  = false
+  issues_events                = false
+  confidential_issues_events   = false
+  merge_requests_events        = false
+  tag_push_events              = false
+  note_events                  = false
+  confidential_note_events     = false
+  pipeline_events              = false
+  wiki_page_events             = false
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `confidential_issues_events` (Boolean) Enable notifications for confidential issues events.
+- `confidential_note_events` (Boolean) Enable notifications for confidential note events.
+- `issues_events` (Boolean) Enable notifications for issues events.
+- `merge_requests_events` (Boolean) Enable notifications for merge requests events.
+- `note_events` (Boolean) Enable notifications for note events.
+- `pipeline_events` (Boolean) Enable notifications for pipeline events.
+- `project` (String) The ID or full path of the project to integrate with Telegram.
+- `push_events` (Boolean) Enable notifications for push events.
+- `room` (String) Unique identifier for the target chat or the username of the target channel (in the format `@channelusername`)
+- `tag_push_events` (Boolean) Enable notifications for tag push events.
+- `token` (String, Sensitive) The Telegram bot token.
+- `wiki_page_events` (Boolean) Enable notifications for wiki page events.
+
+### Optional
+
+- `branches_to_be_notified` (String) Branches to send notifications for (introduced in GitLab 16.5). Update of this attribute was not supported before Gitlab 16.11 due to API bug. Valid options are `all`, `default`, `protected`, `default_and_protected`.
+- `notify_only_broken_pipelines` (Boolean) Send notifications for broken pipelines.
+
+### Read-Only
+
+- `id` (String) The ID of this Terraform resource. In the format of `<project>`.
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+# You can import a gitlab_integration_telegram state using the project ID, e.g.
+terraform import gitlab_integration_telegram.default 1
+```
diff --git a/docs/resources/personal_access_token.md b/docs/resources/personal_access_token.md
@@ -39,11 +39,14 @@ resource "gitlab_project_variable" "example" {
 
 ### Required
 
-- `expires_at` (String) The token expires at midnight UTC on that date. The date must be in the format YYYY-MM-DD.
 - `name` (String) The name of the personal access token.
-- `scopes` (Set of String) The scope for the personal access token. It determines the actions which can be performed when authenticating with this token. Valid values are: `api`, `read_user`, `read_api`, `read_repository`, `write_repository`, `read_registry`, `write_registry`, `sudo`, `admin_mode`, `create_runner`.
+- `scopes` (Set of String) The scope for the personal access token. It determines the actions which can be performed when authenticating with this token. Valid values are: `api`, `read_user`, `read_api`, `read_repository`, `write_repository`, `read_registry`, `write_registry`, `sudo`, `admin_mode`, `create_runner`, `manage_runner`.
 - `user_id` (Number) The id of the user.
 
+### Optional
+
+- `expires_at` (String) The token expires at midnight UTC on that date. The date must be in the format YYYY-MM-DD.
+
 ### Read-Only
 
 - `active` (Boolean) True if the token is active.
diff --git a/docs/resources/project.md b/docs/resources/project.md
@@ -172,7 +172,7 @@ resource "gitlab_project" "import_private" {
 - `import_url_password` (String, Sensitive) The password for the `import_url`. The value of this field is used to construct a valid `import_url` and is only related to the provider. This field cannot be imported using `terraform import`. See the examples section for how to properly use it.
 - `import_url_username` (String) The username for the `import_url`. The value of this field is used to construct a valid `import_url` and is only related to the provider. This field cannot be imported using `terraform import`.  See the examples section for how to properly use it.
 - `infrastructure_access_level` (String) Set the infrastructure access level. Valid values are `disabled`, `private`, `enabled`.
-- `initialize_with_readme` (Boolean) Create main branch with first commit containing a README.md file.
+- `initialize_with_readme` (Boolean) Create main branch with first commit containing a README.md file. Must be set to `true` if importing an uninitialized project with a different `default_branch`.
 - `issues_access_level` (String) Set the issues access level. Valid values are `disabled`, `private`, `enabled`.
 - `issues_enabled` (Boolean) Enable issue tracking for the project.
 - `issues_template` (String) Sets the template for new issues in the project.
diff --git a/docs/resources/project_access_token.md b/docs/resources/project_access_token.md
@@ -48,7 +48,7 @@ resource "gitlab_project_variable" "example" {
 
 - `name` (String) The name of the project access token.
 - `project` (String) The ID or full path of the project.
-- `scopes` (Set of String) The scopes of the project access token. valid values are: `api`, `read_api`, `read_user`, `k8s_proxy`, `read_registry`, `write_registry`, `read_repository`, `write_repository`, `create_runner`, `ai_features`, `k8s_proxy`, `read_observability`, `write_observability`
+- `scopes` (Set of String) The scopes of the project access token. valid values are: `api`, `read_api`, `read_registry`, `write_registry`, `read_repository`, `write_repository`, `create_runner`, `manage_runner`, `ai_features`, `k8s_proxy`, `read_observability`, `write_observability`
 
 ### Optional
 
diff --git a/docs/resources/project_job_token_scopes.md b/docs/resources/project_job_token_scopes.md
@@ -22,18 +22,18 @@ Any project not within the defined set in this attribute will be removed, which
 
 ```terraform
 resource "gitlab_project_job_token_scopes" "allowed_single_project" {
-  project            = "gitlab-org/gitlab"
+  project_id         = 111
   target_project_ids = [123]
 }
 
 resource "gitlab_project_job_token_scopes" "allowed_multiple_project" {
-  project            = "gitlab-org/gitlab"
+  project_id         = 111
   target_project_ids = [123, 456, 789]
 }
 
 # This will remove all job token scopes, even if added outside of TF.
 resource "gitlab_project_job_token_scopes" "explicit_deny" {
-  project            = "gitlab-org/gitlab"
+  project_id         = 111
   target_project_ids = []
 }
 ```
diff --git a/docs/resources/service_slack.md b/docs/resources/service_slack.md
@@ -47,6 +47,7 @@ resource "gitlab_service_slack" "slack" {
 - `branches_to_be_notified` (String) Branches to send notifications for. Valid options are "all", "default", "protected", and "default_and_protected".
 - `confidential_issue_channel` (String) The name of the channel to receive confidential issue events notifications.
 - `confidential_issues_events` (Boolean) Enable notifications for confidential issues events.
+- `confidential_note_channel` (String) The name of the channel to receive confidential note events notifications.
 - `confidential_note_events` (Boolean) Enable notifications for confidential note events.
 - `issue_channel` (String) The name of the channel to receive issue events notifications.
 - `issues_events` (Boolean) Enable notifications for issues events.

Original file line number	Diff line number	Diff line change
`@@ -22,18 +22,18 @@ Any project not within the defined set in this attribute will be removed, which`
`22`	`22`
`23`	`23`	```terraform
`24`	`24`	`resource "gitlab_project_job_token_scopes" "allowed_single_project" {`
`25`		`- project = "gitlab-org/gitlab"`
	`25`	`+ project_id = 111`
`26`	`26`	`target_project_ids = [123]`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`resource "gitlab_project_job_token_scopes" "allowed_multiple_project" {`
`30`		`- project = "gitlab-org/gitlab"`
	`30`	`+ project_id = 111`
`31`	`31`	`target_project_ids = [123, 456, 789]`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`# This will remove all job token scopes, even if added outside of TF.`
`35`	`35`	`resource "gitlab_project_job_token_scopes" "explicit_deny" {`
`36`		`- project = "gitlab-org/gitlab"`
	`36`	`+ project_id = 111`
`37`	`37`	`target_project_ids = []`
`38`	`38`	`}`
`39`	`39`	```