Update docs for v17.7.0 release

gitlab-terraform-provider-bot · gitlab-terraform-provider-bot · commit aca484cec96a · 2024-12-20T08:22:34.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,24 @@
+## 17.7.0 (2024-12-19)
+
+This release was tested against GitLab 17.7, 17.6, and 17.5 for both CE and EE
+
+### FEATURES (1 change)
+
+- resource/gitlab_instance_service_account:  [Allows managing instance-level service accounts](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/0da40eceb4272d3fb856139198da777d08960711) by @ipsavitsky234 ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2220)) 
+
+### IMPROVEMENTS (2 changes)
+
+- resource/gitlab_integration_jira:  [Align Jira integration resource with the API](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/e3b04f9babac66bc96244d32d79c304e639161cd) by @slaup1 ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2221)) 
+- resource/gitlab_project:  [Add support for 'prevent_merge_without_jira_issue'](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/6da24d2c30b017d00f766a6bdb9deb31877be242) by @slaup1 ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2223)) 
+- resource/gitlab_branch: [Add support for `keep_on_destroy`, which will preserve a branch when a `destroy` operation is performed](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/3fa3aae0ea19a71354bc7af13196bac4bd7fdd9a) by @jae-sorcero ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2192))
+
+### BUG FIXES (4 changes)
+
+- resource/gitlab_group_service_account_access_token:  [Fixed an issue where revoking a service account token required more permissions than the documentation suggested when using SaaS](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/b4814f9bec3cbe904cc747f98f1d4adcff3691d0) by @u120230 ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2240)) 
+- resource/gitlab_group:  [Fixed an issue where older versions of GitLab may fail due to missing `DefaultBranchProtectionDefaults`](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/c12242b1c7209cd00db546817a94c72e62ff4d6f) by @PatrickRice ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2228))
+- resource/gitlab_application_settings:  [Fixed an issue where `DefaultBranchProtectionDefaults` didn't apply properly](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/0f8c9e14e92adbee43087c483ccc6ecdfafcc35b) by @PatrickRice ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2229))
+- resource/gitlab_project: [Fixed an issue where `restrict_user_defined_variables` caused a perpetual plan when not included in the config](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/9a371bb386650a1efd79c6b3d8d9073a9d55e81d) by @PatrickRice ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2243))
+
 ## 17.6.1 (2024-11-27)
 
 This release was tested against GitLab 17.6, 17.5, and 17.4 for both CE and EE
@@ -1185,7 +1206,7 @@ ENHANCEMENTS:
 - Support running the provider using an OAuth token ([#686](https://github.com/gitlabhq/terraform-provider-gitlab/pull/686))
 - Allow merge on skipped pipeline ([#705](https://github.com/gitlabhq/terraform-provider-gitlab/pull/705))
 - support default_branch_protection on group ([#706](https://github.com/gitlabhq/terraform-provider-gitlab/pull/706))
-- Bump github.com/xanzy/go-gitlab from 0.50.0 to 0.51.1 ([#718](https://github.com/gitlabhq/terraform-provider-gitlab/pull/718))
+- Bump gitlab.com/gitlab-org/api/client-go from 0.50.0 to 0.51.1 ([#718](https://github.com/gitlabhq/terraform-provider-gitlab/pull/718))
 - Add squash option ([#719](https://github.com/gitlabhq/terraform-provider-gitlab/pull/719))
 
 BUGFIXES:
@@ -1227,7 +1248,7 @@ ENHANCEMENTS:
 - Support the Note field in the User resource/data ([#572](https://github.com/gitlabhq/terraform-provider-gitlab/pull/572))
 - add diffSuppressFunc for 'expires_at' attribute in 'deploy_token' ([#575](https://github.com/gitlabhq/terraform-provider-gitlab/pull/575))
 - Update to Go 1.16 and terraform-plugin-sdk 1.16 ([#579](https://github.com/gitlabhq/terraform-provider-gitlab/pull/579))
-- Bump github.com/xanzy/go-gitlab from 0.44.0 to 0.46.0 ([#586](https://github.com/gitlabhq/terraform-provider-gitlab/pull/586))
+- Bump gitlab.com/gitlab-org/api/client-go from 0.44.0 to 0.46.0 ([#586](https://github.com/gitlabhq/terraform-provider-gitlab/pull/586))
 
 BUG FIXES:
 
diff --git a/docs/data-sources/project.md b/docs/data-sources/project.md
@@ -82,6 +82,7 @@ data "gitlab_project" "example" {
 - `namespace_id` (Number) The namespace (group or user) of the project. Defaults to your user.
 - `path` (String) The path of the repository.
 - `pipelines_enabled` (Boolean) Enable pipelines for the project.
+- `prevent_merge_without_jira_issue` (Boolean) Whether merge requests require an associated issue from Jira. Premium and Ultimate only.
 - `printing_merge_request_link_enabled` (Boolean) Show link to create/view merge request when pushing from the command line
 - `push_rules` (List of Object) Push rules for the project. Push rules are only available on Enterprise plans and if the authenticated has permissions to read them. (see [below for nested schema](#nestedatt--push_rules))
 - `releases_access_level` (String) Set the releases access level. Valid values are `disabled`, `private`, `enabled`.
diff --git a/docs/data-sources/projects.md b/docs/data-sources/projects.md
@@ -153,6 +153,7 @@ Read-Only:
 - `path` (String)
 - `path_with_namespace` (String)
 - `permissions` (List of Object) (see [below for nested schema](#nestedobjatt--projects--permissions))
+- `prevent_merge_without_jira_issue` (Boolean)
 - `public_builds` (Boolean)
 - `readme_url` (String)
 - `releases_access_level` (String)
diff --git a/docs/index.md b/docs/index.md
@@ -9,7 +9,7 @@ Use the GitLab provider to interact with GitLab resources, like
 users, groups, projects and more. You must configure the provider with
 the proper credentials before you can use it.
 
-The provider uses the [`xanzy/go-gitlab`](https://github.com/xanzy/go-gitlab) library
+The provider uses the [`xanzy/go-gitlab`](https://gitlab.com/gitlab-org/api/client-go) library
 to interact with the [GitLab REST API](https://docs.gitlab.com/ee/api/api_resources.html).
 
 Each data source and resource references the appropriate upstream GitLab REST API documentation,
diff --git a/docs/resources/branch.md b/docs/resources/branch.md
@@ -39,6 +39,10 @@ resource "gitlab_branch" "example" {
 - `project` (String) The ID or full path of the project which the branch is created against.
 - `ref` (String) The ref which the branch is created from.
 
+### Optional
+
+- `keep_on_destroy` (Boolean) Indicates whether the branch is kept once the resource destroyed (must be applied before a destroy).
+
 ### Read-Only
 
 - `can_push` (Boolean) Bool, true if you can push to the branch.
diff --git a/docs/resources/instance_service_account.md b/docs/resources/instance_service_account.md
@@ -0,0 +1,40 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "gitlab_instance_service_account Resource - terraform-provider-gitlab"
+subcategory: ""
+description: |-
+  The gitlab_instance_service_account resource allows creating a GitLab instance service account.
+  ~> 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
+  Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/user_service_accounts.html
+---
+
+# gitlab_instance_service_account (Resource)
+
+The `gitlab_instance_service_account` resource allows creating a GitLab instance service account.
+
+~> 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`
+
+**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/user_service_accounts.html)
+
+
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Optional
+
+- `name` (String) The name of the user. If not specified, the default Service account user name is used.
+- `timeouts` (Attributes) (see [below for nested schema](#nestedatt--timeouts))
+- `username` (String) The username of the user. If not specified, it’s automatically generated.
+
+### Read-Only
+
+- `id` (String) The ID of this Terraform resource. This matches the service account id.
+- `service_account_id` (String) The service account id.
+
+<a id="nestedatt--timeouts"></a>
+### Nested Schema for `timeouts`
+
+Optional:
+
+- `delete` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
diff --git a/docs/resources/integration_jira.md b/docs/resources/integration_jira.md
@@ -48,7 +48,7 @@ resource "gitlab_integration_jira" "jira" {
 - `jira_auth_type` (Number) The authentication method to be used with Jira. 0 means Basic Authentication. 1 means Jira personal access token. Defaults to 0.
 - `jira_issue_prefix` (String) Prefix to match Jira issue keys.
 - `jira_issue_regex` (String) Regular expression to match Jira issue keys.
-- `jira_issue_transition_automatic` (Boolean) Enable automatic issue transitions. Takes precedence over jira_issue_transition_id if enabled. Defaults to false.
+- `jira_issue_transition_automatic` (Boolean) Enable automatic issue transitions. Takes precedence over jira_issue_transition_id if enabled. Defaults to false. This value cannot be imported, and will not perform drift detection if changed outside Terraform.
 - `jira_issue_transition_id` (String) The ID of a transition that moves issues to a closed state. You can find this number under the JIRA workflow administration (Administration > Issues > Workflows) by selecting View under Operations of the desired workflow of your project. By default, this ID is set to 2. *Note**: importing this field is only supported since GitLab 15.2.
 - `merge_requests_events` (Boolean) Enable notifications for merge request events
 - `project_key` (String) The short identifier for your JIRA project, all uppercase, e.g., PROJ.
diff --git a/docs/resources/integration_slack.md b/docs/resources/integration_slack.md
@@ -67,7 +67,7 @@ resource "gitlab_integration_slack" "slack" {
 ### Read-Only
 
 - `id` (String) The ID of this resource.
-- `job_events` (Boolean) Enable notifications for job events. **ATTENTION**: This attribute is currently not being submitted to the GitLab API, due to https://github.com/xanzy/go-gitlab/issues/1354.
+- `job_events` (Boolean) Enable notifications for job events. **ATTENTION**: This attribute is currently not being submitted to the GitLab API, due to https://gitlab.com/gitlab-org/api/client-go/issues/1354.
 
 ## Import
 
diff --git a/docs/resources/project.md b/docs/resources/project.md
@@ -203,6 +203,7 @@ resource "gitlab_project" "import_private" {
 - `path` (String) The path of the repository.
 - `pipelines_enabled` (Boolean, Deprecated) Enable pipelines for the project. The `pipelines_enabled` field is being sent as `jobs_enabled` in the GitLab API calls.
 - `pre_receive_secret_detection_enabled` (Boolean) Whether Secret Push Detection is enabled. Requires GitLab Ultimate and at least GitLab 17.3.
+- `prevent_merge_without_jira_issue` (Boolean) Set whether merge requests require an associated issue from Jira. Premium and Ultimate only.
 - `printing_merge_request_link_enabled` (Boolean) Show link to create/view merge request when pushing from the command line
 - `public_builds` (Boolean, Deprecated) If true, jobs can be viewed by non-project members.
 - `public_jobs` (Boolean) If true, jobs can be viewed by non-project members.
diff --git a/docs/resources/service_jira.md b/docs/resources/service_jira.md
@@ -51,7 +51,7 @@ resource "gitlab_service_jira" "jira" {
 - `jira_auth_type` (Number) The authentication method to be used with Jira. 0 means Basic Authentication. 1 means Jira personal access token. Defaults to 0.
 - `jira_issue_prefix` (String) Prefix to match Jira issue keys.
 - `jira_issue_regex` (String) Regular expression to match Jira issue keys.
-- `jira_issue_transition_automatic` (Boolean) Enable automatic issue transitions. Takes precedence over jira_issue_transition_id if enabled. Defaults to false.
+- `jira_issue_transition_automatic` (Boolean) Enable automatic issue transitions. Takes precedence over jira_issue_transition_id if enabled. Defaults to false. This value cannot be imported, and will not perform drift detection if changed outside Terraform.
 - `jira_issue_transition_id` (String) The ID of a transition that moves issues to a closed state. You can find this number under the JIRA workflow administration (Administration > Issues > Workflows) by selecting View under Operations of the desired workflow of your project. By default, this ID is set to 2. *Note**: importing this field is only supported since GitLab 15.2.
 - `merge_requests_events` (Boolean) Enable notifications for merge request events
 - `project_key` (String) The short identifier for your JIRA project, all uppercase, e.g., PROJ.
diff --git a/docs/resources/service_slack.md b/docs/resources/service_slack.md
@@ -70,7 +70,7 @@ resource "gitlab_service_slack" "slack" {
 ### Read-Only
 
 - `id` (String) The ID of this resource.
-- `job_events` (Boolean) Enable notifications for job events. **ATTENTION**: This attribute is currently not being submitted to the GitLab API, due to https://github.com/xanzy/go-gitlab/issues/1354.
+- `job_events` (Boolean) Enable notifications for job events. **ATTENTION**: This attribute is currently not being submitted to the GitLab API, due to https://gitlab.com/gitlab-org/api/client-go/issues/1354.
 
 ## Import
 
