Update docs for v16.10.0 release

gitlab-terraform-provider-bot · gitlab-terraform-provider-bot · commit d908ca10a98d · 2024-03-21T17:21:52.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,30 @@
+## 16.10.0 (2024-03-21)
+
+This release was tested against GitLab 16.8, 16.9, and 16.10 for both CE and EE
+
+NOTES:
+
+- scripts/gitlab.rb has been updated for local development to set the license mode and customer portal URL for testing. If you're using a personal license for local development, you may need to update this file temporarily to run EE locally. ([!1861](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1861))
+
+IMPROVEMENTS:
+- **New Data Source** datasource/gitlab_release: Allows querying a GitLab Release by project and tag name to get release information or assets ([!1851](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1851))
+
+BUG FIXES:
+
+- resources/gitlab_project_level_mr_approvals: fixed a documentation issue with the use of `merge_requests_disable_committers_approval` ([!1864](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1864))
+- resources/gitlab_group_ldap_link: fixed an issue where deleting the group associated to an LDAP link would result in a TF state that required manual intervention. Using a value of `true` with the `force` attribute will now remove the LDAP link from state when the group is deleted. ([!1842](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1842))
+- resources/gitlab_cluster_agent: fixed the example documentation to show the file contents as encoded ([!1852](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1852))
+- resources/gitlab_pipeline_schedule: fixed a potential panic on the provider that could occur when there was an error editing the pipeline schedule ([!1847](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1847))
+
+
+## 16.9.1 (2024-02-15)
+
+This release was tested against GitLab 16.7, 16.8, and 16.9 for both CE and EE
+
+BUG FIXES:
+
+- Fixed a Go version mismatch when using `goreleaser` that prevented v16.9.0 from being published properly ([!1839](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1839))
+
 ## 16.9.0 (2024-02-15)
 
 This release was tested against GitLab 16.7, 16.8, and 16.9 for both CE and EE
diff --git a/docs/data-sources/release.md b/docs/data-sources/release.md
@@ -0,0 +1,69 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "gitlab_release Data Source - terraform-provider-gitlab"
+subcategory: ""
+description: |-
+  The gitlab_release data source retrieves information about a gitlab release for a project.
+  Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/releases/
+---
+
+# gitlab_release (Data Source)
+
+The `gitlab_release` data source retrieves information about a gitlab release for a project.
+
+**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/releases/)
+
+## Example Usage
+
+```terraform
+# By project ID and tag_name
+data "gitlab_release" "example" {
+  project_id = 1234
+  tag_name   = "v1.0"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `project_id` (String) The ID or URL-encoded path of the project.
+- `tag_name` (String) The Git tag the release is associated with.
+
+### Read-Only
+
+- `assets` (Block, Read-only) The assets for a release (see [below for nested schema](#nestedblock--assets))
+- `created_at` (String) The date the release was created.
+- `description` (String) An HTML rendered description of the release.
+- `id` (String) The ID of this Terraform resource. In the format of `<project_id:tag_name>`.
+- `name` (String) The name of the release.
+- `released_at` (String) The date the release was created.
+
+<a id="nestedblock--assets"></a>
+### Nested Schema for `assets`
+
+Read-Only:
+
+- `count` (Number) The number of assets for a release
+- `links` (Block List) The links for a release (see [below for nested schema](#nestedblock--assets--links))
+- `sources` (Block List) The sources for a release (see [below for nested schema](#nestedblock--assets--sources))
+
+<a id="nestedblock--assets--links"></a>
+### Nested Schema for `assets.links`
+
+Read-Only:
+
+- `id` (Number) The ID of the link
+- `link_type` (String) The type of the link
+- `name` (String) The name of the link
+- `url` (String) The URL of the link
+
+
+<a id="nestedblock--assets--sources"></a>
+### Nested Schema for `assets.sources`
+
+Read-Only:
+
+- `format` (String) The format of the source
+- `url` (String) The URL of the source
diff --git a/docs/resources/cluster_agent.md b/docs/resources/cluster_agent.md
@@ -39,16 +39,16 @@ resource "gitlab_cluster_agent" "example" {
 // Optionally, configure the agent as described in
 // https://docs.gitlab.com/ee/user/clusters/agent/install/index.html#create-an-agent-configuration-file
 resource "gitlab_repository_file" "example_agent_config" {
-  project        = gitlab_cluster_agent.example.project
-  branch         = "main" // or use the `default_branch` attribute from a project data source / resource
-  file_path      = ".gitlab/agents/${gitlab_cluster_agent.example.name}"
-  content        = <<CONTENT
-  gitops:
-    ...
+  project   = gitlab_cluster_agent.example.project
+  branch    = "main" // or use the `default_branch` attribute from a project data source / resource
+  file_path = ".gitlab/agents/${gitlab_cluster_agent.example.name}/config.yaml"
+  content = base64encode(<<CONTENT
+# the GitLab Agent for Kubernetes configuration goes here ...
   CONTENT
+  )
   author_email   = "terraform@example.com"
   author_name    = "Terraform"
-  commit_message = "feature: add agent config for ${gitlab_cluster_agent.example.name}"
+  commit_message = "feature: add agent config for ${gitlab_cluster_agent.example.name} [skip ci]"
 }
 ```
 
diff --git a/docs/resources/group_ldap_link.md b/docs/resources/group_ldap_link.md
@@ -37,7 +37,7 @@ resource "gitlab_group_ldap_link" "test" {
 - `access_level` (String, Deprecated) Minimum access level for members of the LDAP group. Valid values are: `no one`, `minimal`, `guest`, `reporter`, `developer`, `maintainer`, `owner`, `master`
 - `cn` (String) The CN of the LDAP group to link with. Required if `filter` is not provided.
 - `filter` (String) The LDAP filter for the group. Required if `cn` is not provided. Requires GitLab Premium or above.
-- `force` (Boolean) If true, then delete and replace an existing LDAP link if one exists.
+- `force` (Boolean) If true, then delete and replace an existing LDAP link if one exists. Will also remove an LDAP link if the parent group is not found.
 - `group_access` (String) Minimum access level for members of the LDAP group. Valid values are: `no one`, `minimal`, `guest`, `reporter`, `developer`, `maintainer`, `owner`, `master`
 
 ### Read-Only
diff --git a/docs/resources/project_level_mr_approvals.md b/docs/resources/project_level_mr_approvals.md
@@ -44,7 +44,7 @@ resource "gitlab_project_level_mr_approvals" "foo" {
 
 - `disable_overriding_approvers_per_merge_request` (Boolean) Set to `true` to disable overriding approvers per merge request.
 - `merge_requests_author_approval` (Boolean) Set to `true` to allow merge requests authors to approve their own merge requests.
-- `merge_requests_disable_committers_approval` (Boolean) Set to `true` to allow merge requests committers to approve their own merge requests.
+- `merge_requests_disable_committers_approval` (Boolean) Set to `true` to disable merge request committers from approving their own merge requests.
 - `require_password_to_approve` (Boolean) Set to `true` to require authentication to approve merge requests.
 - `reset_approvals_on_push` (Boolean) Set to `true` to remove all approvals in a merge request when new commits are pushed to its source branch. Default is `true`.
 - `selective_code_owner_removals` (Boolean) Reset approvals from Code Owners if their files changed. Can be enabled only if reset_approvals_on_push is disabled.
