Update docs for v15.9.0 release

Author: gitlab-terraform-provider-bot

CHANGELOG.md

@@ -56,6 +56,7 @@ data "gitlab_project" "example" {
 - `external_authorization_classification_label` (String) The classification label for the project.
 - `forking_access_level` (String) Set the forking access level. Valid values are `disabled`, `private`, `enabled`.
 - `http_url_to_repo` (String) URL that can be provided to `git clone` to clone the
+- `import_url` (String) URL the project was imported from.
 - `issues_access_level` (String) Set the issues access level. Valid values are `disabled`, `private`, `enabled`.
 - `issues_enabled` (Boolean) Enable issue tracking for the project.
 - `lfs_enabled` (Boolean) Enable LFS for the project.
@@ -70,7 +71,7 @@ data "gitlab_project" "example" {
 - `path` (String) The path of the repository.
 - `pipelines_enabled` (Boolean) Enable pipelines for the project.
 - `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. (see [below for nested schema](#nestedatt--push_rules))
+- `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))
 - `remove_source_branch_after_merge` (Boolean) Enable `Delete source branch` option by default for all new merge requests
 - `repository_access_level` (String) Set the repository access level. Valid values are `disabled`, `private`, `enabled`.
 - `repository_storage` (String) Which storage shard the repository is on. (administrator only)

docs/data-sources/project.md

@@ -112,6 +112,7 @@ Read-Only:
 - `id` (Number)
 - `import_error` (String)
 - `import_status` (String)
+- `import_url` (String)
 - `issues_access_level` (String)
 - `issues_enabled` (Boolean)
 - `jobs_enabled` (Boolean)

docs/data-sources/projects.md

@@ -75,6 +75,6 @@ resource "gitlab_project" "sample_group_project" {
 - `cacert_file` (String) This is a file containing the ca cert to verify the gitlab instance. This is available for use when working with GitLab CE or Gitlab Enterprise with a locally-issued or self-signed certificate chain.
 - `client_cert` (String) File path to client certificate when GitLab instance is behind company proxy. File must contain PEM encoded data.
 - `client_key` (String) File path to client key when GitLab instance is behind company proxy. File must contain PEM encoded data. Required when `client_cert` is set.
-- `early_auth_check` (Boolean) (Experimental) By default the provider does a dummy request to get the current user in order to verify that the provider configuration is correct and the GitLab API is reachable. Set this to `false` to skip this check. This may be useful if the GitLab instance does not yet exist and is created within the same terraform module. This is an experimental feature and may change in the future. Please make sure to always keep backups of your state.
+- `early_auth_check` (Boolean) (Experimental) By default the provider does a dummy request to get the current user in order to verify that the provider configuration is correct and the GitLab API is reachable. Set this to `false` to skip this check. This may be useful if the GitLab instance does not yet exist and is created within the same terraform module. It may be sourced from the `GITLAB_EARLY_AUTH_CHECK`. This is an experimental feature and may change in the future. Please make sure to always keep backups of your state.
 - `insecure` (Boolean) When set to true this disables SSL verification of the connection to the GitLab instance.
 - `token` (String, Sensitive) The OAuth2 Token, Project, Group, Personal Access Token or CI Job Token used to connect to GitLab. The OAuth method is used in this provider for authentication (using Bearer authorization token). See https://docs.gitlab.com/ee/api/#authentication for details. It may be sourced from the `GITLAB_TOKEN` environment variable.

docs/index.md

@@ -0,0 +1,66 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "gitlab_pages_domain Resource - terraform-provider-gitlab"
+subcategory: ""
+description: |-
+  The gitlab_pages_domain resource allows connecting custom domains and TLS certificates in GitLab Pages.
+  Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/pages_domains.html
+---
+
+# gitlab_pages_domain (Resource)
+
+The `gitlab_pages_domain` resource allows connecting custom domains and TLS certificates in GitLab Pages.
+
+**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/pages_domains.html)
+
+## Example Usage
+
+```terraform
+# Example using auto_ssl_enabled, which uses lets encrypt to generate a certificate
+resource "gitlab_pages_domain" "this" {
+  project = 123
+  domain  = "example.com"
+
+  auto_ssl_enabled = true
+}
+
+# Example using a manually generated certificate and key
+resource "gitlab_pages_domain" "this" {
+  project = 123
+  domain  = "example.com"
+
+  key         = file("${path.module}/key.pem")
+  certificate = file("${path.module}/cert.pem")
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `domain` (String) The custom domain indicated by the user.
+- `project` (String) The ID or [URL-encoded path of the project](https://docs.gitlab.com/ee/api/index.html#namespaced-path-encoding) owned by the authenticated user.
+
+### Optional
+
+- `auto_ssl_enabled` (Boolean) Enables [automatic generation](https://docs.gitlab.com/ee/user/project/pages/custom_domains_ssl_tls_certification/lets_encrypt_integration.html) of SSL certificates issued by Let’s Encrypt for custom domains. When this is set to "true", certificate can't be provided.
+- `certificate` (String) The certificate in PEM format with intermediates following in most specific to least specific order.
+- `expired` (Boolean) Whether the certificate is expired.
+- `key` (String) The certificate key in PEM format.
+
+### Read-Only
+
+- `id` (String) The ID of this Terraform resource. In the format of `<project>:<domain>`.
+- `url` (String) The URL for the given domain.
+- `verification_code` (String, Sensitive) The verification code for the domain.
+- `verified` (Boolean) The certificate data.
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+# GitLab pages domain can be imported using an id made up of `projectId:domain` _without_ the http protocol, e.g.
+terraform import gitlab_pages_domain.this 123:example.com
+```

docs/resources/pages_domain.md

@@ -77,6 +77,50 @@ resource "gitlab_project" "fork" {
   import_url             = gitlab_project.example.http_url_to_repo
   mirror                 = true
 }
+
+# Create a project by importing it from a public project
+resource "gitlab_project" "import_public" {
+  name       = "import-from-public-project"
+  import_url = "https://gitlab.example.com/repo.git"
+}
+
+# Create a project by importing it from a public project and setup the pull mirror
+resource "gitlab_project" "import_public_with_mirror" {
+  name       = "import-from-public-project"
+  import_url = "https://gitlab.example.com/repo.git"
+  mirror     = true
+}
+
+# Create a project by importing it from a private project
+resource "gitlab_project" "import_private" {
+  name                = "import-from-public-project"
+  import_url          = "https://gitlab.example.com/repo.git"
+  import_url_username = "user"
+  import_url_password = "pass"
+}
+
+# Create a project by importing it from a private project and setup the pull mirror
+resource "gitlab_project" "import_private_with_mirror" {
+  name                = "import-from-public-project"
+  import_url          = "https://gitlab.example.com/repo.git"
+  import_url_username = "user"
+  import_url_password = "pass"
+  mirror              = true
+}
+
+# Create a project by importing it from a private project and provide credentials in `import_url`
+# NOTE: only use this if you really must, use `import_url_username` and `import_url_password` whenever possible
+#       GitLab API will always return the `import_url` without credentials, therefore you must ignore the `import_url` for changes:
+resource "gitlab_project" "import_private" {
+  name       = "import-from-public-project"
+  import_url = "https://user:[email protected]/repo.git"
+
+  lifecycle {
+    ignore_changes = [
+      import_url
+    ]
+  }
+}
 ```
 
 <!-- schema generated by tfplugindocs -->
@@ -120,7 +164,9 @@ resource "gitlab_project" "fork" {
 - `forked_from_project_id` (Number) The id of the project to fork. During create the project is forked and during an update the fork relation is changed.
 - `forking_access_level` (String) Set the forking access level. Valid values are `disabled`, `private`, `enabled`.
 - `group_with_project_templates_id` (Number) For group-level custom templates, specifies ID of group from which all the custom project templates are sourced. Leave empty for instance-level templates. Requires use_custom_template to be true (enterprise edition).
-- `import_url` (String) Git URL to a repository to be imported. Together with `mirror = true` it will setup a Pull Mirror. This can also be used together with `forked_from_project_id` to setup a Pull Mirror for a fork. The fork takes precedence over the import. This field cannot be imported via `terraform import`.
+- `import_url` (String) Git URL to a repository to be imported. Together with `mirror = true` it will setup a Pull Mirror. This can also be used together with `forked_from_project_id` to setup a Pull Mirror for a fork. The fork takes precedence over the import. Make sure to provide the credentials in `import_url_username` and `import_url_password`. GitLab never returns the credentials, thus the provider cannot detect configuration drift in the credentials. They can also not be imported using `terraform import`. See the examples section for how to properly use it.
+- `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.
 - `initialize_with_readme` (Boolean) Create main branch with first commit containing a README.md file.
 - `issues_access_level` (String) Set the issues access level. Valid values are `disabled`, `private`, `enabled`.
 - `issues_enabled` (Boolean) Enable issue tracking for the project.
@@ -229,4 +275,6 @@ Import is supported using the following syntax:
 # `id` can be whatever the [get single project api][get_single_project] takes for
 # its `:id` value, so for example:
 terraform import gitlab_project.example richardc/example
+
+# NOTE: the `import_url_username` and `import_url_password` cannot be imported.
 ```