Update docs for v16.2.0 release

gitlab-terraform-provider-bot · gitlab-terraform-provider-bot · commit 6e47f04efc7f · 2023-07-22T16:28:51.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,22 @@
+## 16.2.0 (2023-07-22)
+
+This release was tested against GitLab 15.11, 16.0 and 16.1 for both CE and EE.
+
+IMPROVEMENTS:
+
+- **New Resource:** `gitlab_project_compliance_framework` ([!1616](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1616))
+- **New Resource:** `gitlab_compliance_framework` ([!1599](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1599))
+- resource/gitlab_group_badge: Improve examples to contain common badges ([!1627](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1627))
+- resource/branch_protection: Add support for `admin` as a value for `unprotect_access_level` ([!1626](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1626))
+- datasource/gitlab_groups: Add `top_level_only` support ([!1606](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1606))
+- datasource/gitlab_project: Add `topic` support ([!1610](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1610))
+
+BUG FIXES:
+
+- resource/gitlab_application_settings: Fix documentation to list the correct `import_sources` ([!1638](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1638))
+- resource/gitlab_project: Previously, `name_regex_delete` was improperly deprecated. Remove deprecation notice, and add notice to `name_regex`, which is the proper field ([!1600](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1600))
+- resource/gitlab_repository_file: Fix an issue where updating a repository file when using the `text` encoding returned a base64 encoding error ([!1642](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1642))
+
 ## 16.1.1 (2023-07-17)
 
 This release was tested against GitLab 15.11, 16.0 and 16.1 for both CE and EE.
diff --git a/docs/data-sources/groups.md b/docs/data-sources/groups.md
@@ -40,6 +40,7 @@ data "gitlab_groups" "example-two" {
 - `order_by` (String) Order the groups' list by `id`, `name`, `path`, or `similarity`. (Requires administrator privileges)
 - `search` (String) Search groups by name or path.
 - `sort` (String) Sort groups' list in asc or desc order. (Requires administrator privileges)
+- `top_level_only` (Boolean) Limit to top level groups, excluding all subgroups.
 
 ### Read-Only
 
diff --git a/docs/data-sources/projects.md b/docs/data-sources/projects.md
@@ -61,6 +61,7 @@ data "gitlab_projects" "projects" {
 - `sort` (String) Return projects sorted in `asc` or `desc` order. Default is `desc`.
 - `starred` (Boolean) Limit by projects starred by the current user.
 - `statistics` (Boolean) Include project statistics. Cannot be used with `group_id`.
+- `topic` (Set of String) Limit by projects that have all of the given topics.
 - `visibility` (String) Limit by visibility `public`, `internal`, or `private`.
 - `with_custom_attributes` (Boolean) Include custom attributes in response _(admins only)_.
 - `with_issues_enabled` (Boolean) Limit by projects with issues feature enabled. Default is `false`.
diff --git a/docs/data-sources/repository_file.md b/docs/data-sources/repository_file.md
@@ -36,7 +36,7 @@ data "gitlab_repository_file" "example" {
 
 - `blob_id` (String) The blob id.
 - `commit_id` (String) The commit id.
-- `content` (String) File content. If the content is not yet base64 encoded, it will be encoded automatically. No other encoding is currently supported, because of a [GitLab API bug](https://gitlab.com/gitlab-org/gitlab/-/issues/342430).
+- `content` (String) File content.
 - `content_sha256` (String) File content sha256 digest.
 - `encoding` (String) The file content encoding.
 - `execute_filemode` (Boolean) Enables or disables the execute flag on the file. **Note**: requires GitLab 14.10 or newer.
diff --git a/docs/resources/application_settings.md b/docs/resources/application_settings.md
@@ -166,7 +166,7 @@ resource "gitlab_application_settings" "this" {
 - `housekeeping_gc_period` (Number) Number of Git pushes after which git gc is run.
 - `housekeeping_incremental_repack_period` (Number) Number of Git pushes after which an incremental git repack is run.
 - `html_emails_enabled` (Boolean) Enable HTML emails.
-- `import_sources` (List of String) Sources to allow project import from, possible values: github, bitbucket, bitbucket_server, gitlab, fogbugz, git, gitlab_project, gitea, manifest, and phabricator.
+- `import_sources` (List of String) Sources to allow project import from. Valid values are: `github`, `bitbucket`, `bitbucket_server`, `fogbugz`, `git`, `gitlab_project`, `gitea`, `manifest`
 - `in_product_marketing_emails_enabled` (Boolean) Enable in-product marketing emails.
 - `inactive_projects_delete_after_months` (Number) If delete_inactive_projects is true, the time (in months) to wait before deleting inactive projects. Introduced in GitLab 14.10. Became operational in GitLab 15.0.
 - `inactive_projects_min_size_mb` (Number) If delete_inactive_projects is true, the minimum repository size for projects to be checked for inactivity. Introduced in GitLab 14.10. Became operational in GitLab 15.0.
diff --git a/docs/resources/branch_protection.md b/docs/resources/branch_protection.md
@@ -96,7 +96,7 @@ resource "gitlab_branch_protection" "main" {
 - `code_owner_approval_required` (Boolean) Can be set to true to require code owner approval before merging. Only available own Premium and Ultimate instances.
 - `merge_access_level` (String) Access levels allowed to merge. Valid values are: `no one`, `developer`, `maintainer`.
 - `push_access_level` (String) Access levels allowed to push. Valid values are: `no one`, `developer`, `maintainer`.
-- `unprotect_access_level` (String) Access levels allowed to unprotect. Valid values are: `developer`, `maintainer`.
+- `unprotect_access_level` (String) Access levels allowed to unprotect. Valid values are: `developer`, `maintainer`, `admin`.
 
 ### Read-Only
 
diff --git a/docs/resources/compliance_framework.md b/docs/resources/compliance_framework.md
@@ -0,0 +1,65 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "gitlab_compliance_framework Resource - terraform-provider-gitlab"
+subcategory: ""
+description: |-
+  The gitlab_compliance_framework resource allows to manage the lifecycle of a compliance framework on top-level groups.
+  There can be only one default compliance framework. Of all the configured compliance frameworks marked as default, the last one applied will be the default compliance framework.
+  -> This resource requires a GitLab Enterprise instance with a Premium license to create the compliance framework.
+  -> This resource requires a GitLab Enterprise instance with an Ultimate license to specify a compliance pipeline configuration in the compliance framework.
+  Upstream API: GitLab GraphQL API docs https://docs.gitlab.com/ee/api/graphql/reference/#mutationcreatecomplianceframework
+---
+
+# gitlab_compliance_framework (Resource)
+
+The `gitlab_compliance_framework` resource allows to manage the lifecycle of a compliance framework on top-level groups.
+
+There can be only one `default` compliance framework. Of all the configured compliance frameworks marked as default, the last one applied will be the default compliance framework.
+
+-> This resource requires a GitLab Enterprise instance with a Premium license to create the compliance framework.
+
+-> This resource requires a GitLab Enterprise instance with an Ultimate license to specify a compliance pipeline configuration in the compliance framework.
+
+**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/ee/api/graphql/reference/#mutationcreatecomplianceframework)
+
+## Example Usage
+
+```terraform
+resource "gitlab_compliance_framework" "sample" {
+  namespace_path                   = "top-level-group"
+  name                             = "HIPAA"
+  description                      = "A HIPAA Compliance Framework"
+  color                            = "#87BEEF"
+  default                          = false
+  pipeline_configuration_full_path = ".hipaa.yml@top-level-group/compliance-frameworks"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `color` (String) New color representation of the compliance framework in hex format. e.g. #FCA121.
+- `description` (String) Description for the compliance framework.
+- `name` (String) Name for the compliance framework.
+- `namespace_path` (String) Full path of the namespace to add the compliance framework to.
+
+### Optional
+
+- `default` (Boolean) Set this compliance framework as the default framework for the group. Default: `false`
+- `pipeline_configuration_full_path` (String) Full path of the compliance pipeline configuration stored in a project repository, such as `.gitlab/.compliance-gitlab-ci.yml@compliance/hipaa`. Required format: `path/file.y[a]ml@group-name/project-name` **Note**: Ultimate license required.
+
+### Read-Only
+
+- `framework_id` (String) Globally unique ID of the compliance framework.
+- `id` (String) The ID of this Terraform resource. In the format of `<namespace_path>:<framework_id>`.
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+# Gitlab compliance frameworks can be imported with a key composed of `<namespace_path>:<framework_id>`, e.g.
+terraform import gitlab_compliance_framework.sample "top-level-group:gid://gitlab/ComplianceManagement::Framework/12345"
+```
diff --git a/docs/resources/group_badge.md b/docs/resources/group_badge.md
@@ -3,13 +3,13 @@
 page_title: "gitlab_group_badge Resource - terraform-provider-gitlab"
 subcategory: ""
 description: |-
-  The gitlab_group_badge resource allows to mange the lifecycle of group badges.
+  The gitlab_group_badge resource allows to manage the lifecycle of group badges.
   Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/user/project/badges.html#group-badges
 ---
 
 # gitlab_group_badge (Resource)
 
-The `gitlab_group_badge` resource allows to mange the lifecycle of group badges.
+The `gitlab_group_badge` resource allows to manage the lifecycle of group badges.
 
 **Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/user/project/badges.html#group-badges)
 
@@ -25,6 +25,27 @@ resource "gitlab_group_badge" "example" {
   link_url  = "https://example.com/badge-123"
   image_url = "https://example.com/badge-123.svg"
 }
+
+# Pipeline status badges with placeholders will be enabled for each project
+resource "gitlab_group_badge" "gitlab_pipeline" {
+  group     = gitlab_group.foo.id
+  link_url  = "https://gitlab.example.com/%%{project_path}/-/pipelines?ref=%%{default_branch}"
+  image_url = "https://gitlab.example.com/%%{project_path}/badges/%%{default_branch}/pipeline.svg"
+}
+
+# Test coverage report badges with placeholders will be enabled for each project
+resource "gitlab_group_badge" "gitlab_coverage" {
+  group     = gitlab_group.foo.id
+  link_url  = "https://gitlab.example.com/%%{project_path}/-/jobs"
+  image_url = "https://gitlab.example.com/%%{project_path}/badges/%%{default_branch}/coverage.svg"
+}
+
+# Latest release badges with placeholders will be enabled for each project
+resource "gitlab_group_badge" "gitlab_release" {
+  group     = gitlab_group.foo.id
+  link_url  = "https://gitlab.example.com/%%{project_path}/-/releases"
+  image_url = "https://gitlab.example.com/%%{project_path}/-/badges/release.svg"
+}
 ```
 
 <!-- schema generated by tfplugindocs -->
diff --git a/docs/resources/project_badge.md b/docs/resources/project_badge.md
@@ -3,13 +3,13 @@
 page_title: "gitlab_project_badge Resource - terraform-provider-gitlab"
 subcategory: ""
 description: |-
-  The gitlab_project_badge resource allows to mange the lifecycle of project badges.
+  The gitlab_project_badge resource allows to manage the lifecycle of project badges.
   Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/user/project/badges.html#project-badges
 ---
 
 # gitlab_project_badge (Resource)
 
-The `gitlab_project_badge` resource allows to mange the lifecycle of project badges.
+The `gitlab_project_badge` resource allows to manage the lifecycle of project badges.
 
 **Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/user/project/badges.html#project-badges)
 
@@ -26,6 +26,30 @@ resource "gitlab_project_badge" "example" {
   image_url = "https://example.com/badge-123.svg"
   name      = "badge-123"
 }
+
+# Pipeline status badges with placeholders will be enabled
+resource "gitlab_project_badge" "gitlab_pipeline" {
+  project   = gitlab_project.foo.id
+  link_url  = "https://gitlab.example.com/%%{project_path}/-/pipelines?ref=%%{default_branch}"
+  image_url = "https://gitlab.example.com/%%{project_path}/badges/%%{default_branch}/pipeline.svg"
+  name      = "badge-pipeline"
+}
+
+# Test coverage report badges with placeholders will be enabled
+resource "gitlab_project_badge" "gitlab_coverage" {
+  project   = gitlab_project.foo.id
+  link_url  = "https://gitlab.example.com/%%{project_path}/-/jobs"
+  image_url = "https://gitlab.example.com/%%{project_path}/badges/%%{default_branch}/coverage.svg"
+  name      = "badge-coverage"
+}
+
+# Latest release badges with placeholders will be enabled
+resource "gitlab_project_badge" "gitlab_release" {
+  project   = gitlab_project.foo.id
+  link_url  = "https://gitlab.example.com/%%{project_path}/-/releases"
+  image_url = "https://gitlab.example.com/%%{project_path}/-/badges/release.svg"
+  name      = "badge-release"
+}
 ```
 
 <!-- schema generated by tfplugindocs -->
diff --git a/docs/resources/project_compliance_framework.md b/docs/resources/project_compliance_framework.md
@@ -0,0 +1,56 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "gitlab_project_compliance_framework Resource - terraform-provider-gitlab"
+subcategory: ""
+description: |-
+  The gitlab_project_compliance_framework resource allows to manage the lifecycle of a compliance framework on a project.
+  -> This resource requires a GitLab Enterprise instance with a Premium license to set the compliance framework on a project.
+  Upstream API: GitLab GraphQL API docs https://docs.gitlab.com/ee/api/graphql/reference/#mutationprojectsetcomplianceframework
+---
+
+# gitlab_project_compliance_framework (Resource)
+
+The `gitlab_project_compliance_framework` resource allows to manage the lifecycle of a compliance framework on a project.
+
+-> This resource requires a GitLab Enterprise instance with a Premium license to set the compliance framework on a project.
+
+**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/ee/api/graphql/reference/#mutationprojectsetcomplianceframework)
+
+## Example Usage
+
+```terraform
+resource "gitlab_compliance_framework" "sample" {
+  namespace_path                   = "top-level-group"
+  name                             = "HIPAA"
+  description                      = "A HIPAA Compliance Framework"
+  color                            = "#87BEEF"
+  default                          = false
+  pipeline_configuration_full_path = ".hipaa.yml@top-level-group/compliance-frameworks"
+}
+
+resource "gitlab_project_compliance_framework" "sample" {
+  compliance_framework_id = gitlab_compliance_framework.sample.framework_id
+  project                 = "12345678"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `compliance_framework_id` (String) Globally unique ID of the compliance framework to assign to the project.
+- `project` (String) The ID or full path of the project to change the compliance framework of.
+
+### Read-Only
+
+- `id` (String) The ID of this Terraform resource.
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+# Gitlab project compliance frameworks can be imported with a key composed of `<project_id>`, e.g.
+terraform import gitlab_project_compliance_framework.sample "42"
+```
diff --git a/docs/resources/repository_file.md b/docs/resources/repository_file.md
@@ -79,7 +79,7 @@ resource "gitlab_repository_file" "readme_for_dogs" {
 
 - `branch` (String) Name of the branch to which to commit to.
 - `commit_message` (String) Commit message.
-- `content` (String) File content. If the content is not yet base64 encoded, it will be encoded automatically. No other encoding is currently supported, because of a [GitLab API bug](https://gitlab.com/gitlab-org/gitlab/-/issues/342430).
+- `content` (String) File content.
 - `file_path` (String) The full path of the file. It must be relative to the root of the project without a leading slash `/` or `./`.
 - `project` (String) The name or ID of the project.
 
