Skip to content

Commit 9cce7f6

Browse files
Update docs for v15.10.0 release
1 parent b43eeea commit 9cce7f6

13 files changed

+225
-10
lines changed

CHANGELOG.md

+39
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,42 @@
1+
## 15.10.0 (2023-03-22)
2+
3+
This release was tested against GitLab 15.8, 15.9 and 15.10 for both CE and EE.
4+
5+
FEATURES:
6+
7+
- **New Resource:** `gitlab_application` ([#1436](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1436))
8+
- **New Resource:** `gitlab_service_custom_issue_tracker` ([#1459](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1459))
9+
10+
IMPROVEMENTS:
11+
12+
- resource/gitlab_personal_access_token: Support `admin_mode` as value in the `scopes` attribute ([#1456](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1456))
13+
- resource/gitlab_group: Remove explicit attribute defaults. This solves an issue where newly imported resources may have plan changes for default attributes. In some cases, the new API-based default values are more permissive than the old provider-based defaults. See The linked MR for details. ([#1479](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1479))
14+
- resource/gitlab_repository_file: Add validator to avoid leading `/` and `./` in path ([#1472](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1472))
15+
- resource/gitlab_project: Deprecate the `name_regex_delete` in favor of the `name_regex` attribute ([#1466](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1466))
16+
- resource/gitlab_project: Support `environments_access_level` attribute ([#1469](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1469))
17+
- resource/gitlab_project: Support `feature_flags_access_level` attribute ([#1469](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1469))
18+
- resource/gitlab_project: Support `infrastructure_access_level` attribute ([#1469](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1469))
19+
- resource/gitlab_project: Support `monitor_access_level` attribute ([#1469](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1469))
20+
- resource/gitlab_project: Support `release_access_level` attribute ([#1469](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1469))
21+
- datasource/gitlab_project: Mark `runners_token` as sensitive ([#1461](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1461))
22+
- datasource/gitlab_project: Support `environments_access_level` attribute ([#1469](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1469))
23+
- datasource/gitlab_project: Support `feature_flags_access_level` attribute ([#1469](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1469))
24+
- datasource/gitlab_project: Support `infrastructure_access_level` attribute ([#1469](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1469))
25+
- datasource/gitlab_project: Support `monitor_access_level` attribute ([#1469](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1469))
26+
- datasource/gitlab_project: Support `release_access_level` attribute ([#1469](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1469))
27+
- datasource/gitlab_projects: Support `environments_access_level` attribute ([#1469](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1469))
28+
- datasource/gitlab_projects: Support `feature_flags_access_level` attribute ([#1469](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1469))
29+
- datasource/gitlab_projects: Support `infrastructure_access_level` attribute ([#1469](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1469))
30+
- datasource/gitlab_projects: Support `monitor_access_level` attribute ([#1469](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1469))
31+
- datasource/gitlab_projects: Support `release_access_level` attribute ([#1469](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1469))
32+
33+
BUG FIXES:
34+
35+
- resource/gitlab_project: Add validator to the `id` attribute to prevent misuse ([#1476](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1476))
36+
- resource/gitlab_group: Wait for the group to be fully created and functional ([#1465](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1465))
37+
- resource/gitlab_service_slack: Fix perpetual diff in `webhook` attribute due to upstream API deprecation ([#1470](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1470))
38+
- resource/gitlab_service_microsoft_teams: Fix perpetual diff in `webhook` attribute due to upstream API deprecation ([#1470](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1470))
39+
140
## 15.9.0 (2023-02-22)
241

342
This release was tested against GitLab 15.7, 15.8 and 15.9 for both CE and EE.

docs/data-sources/application.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "gitlab_application Data Source - terraform-provider-gitlab"
4+
subcategory: ""
5+
description: |-
6+
The gitlab_application data source retrieves information about a gitlab application.
7+
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/applications.html
8+
---
9+
10+
# gitlab_application (Data Source)
11+
12+
The `gitlab_application` data source retrieves information about a gitlab application.
13+
14+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/applications.html)
15+
16+
## Example Usage
17+
18+
```terraform
19+
data "gitlab_application" "oidc" {
20+
application_id = 1
21+
}
22+
```
23+
24+
<!-- schema generated by tfplugindocs -->
25+
## Schema
26+
27+
### Required
28+
29+
- `id` (String) The ID of this Terraform resource. In the format of `<application_id>`.
30+
31+
### Read-Only
32+
33+
- `application_id` (String) Internal GitLab application id.
34+
- `confidential` (Boolean) Indicates if the application is kept confidential.
35+
- `name` (String) The name of the GitLab application.
36+
- `redirect_url` (String) The redirect url of the application.
37+
38+

docs/data-sources/project.md

+11-3
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,14 @@ The `gitlab_project` data source allows details of a project to be retrieved by
1616
## Example Usage
1717

1818
```terraform
19+
# To search for a project by ID, pass in the ID value
1920
data "gitlab_project" "example" {
2021
id = 30
2122
}
2223
24+
# To search for a project based on a path, use `path_with_namespace` instead
2325
data "gitlab_project" "example" {
24-
id = "foo/bar/baz"
26+
path_with_namespace = "foo/bar/baz"
2527
}
2628
```
2729

@@ -31,7 +33,7 @@ data "gitlab_project" "example" {
3133
### Optional
3234

3335
- `ci_default_git_depth` (Number) Default number of revisions for shallow cloning.
34-
- `id` (String) The integer or path with namespace that uniquely identifies the project within the gitlab install.
36+
- `id` (String) The integer that uniquely identifies the project within the gitlab install.
3537
- `path_with_namespace` (String) The path of the repository with namespace.
3638
- `public_builds` (Boolean) If true, jobs can be viewed by non-project members.
3739

@@ -53,10 +55,13 @@ data "gitlab_project" "example" {
5355
- `default_branch` (String) The default branch for the project.
5456
- `description` (String) A description of the project.
5557
- `emails_disabled` (Boolean) Disable email notifications.
58+
- `environments_access_level` (String) Set the environments access level. Valid values are `disabled`, `private`, `enabled`.
5659
- `external_authorization_classification_label` (String) The classification label for the project.
60+
- `feature_flags_access_level` (String) Set the feature flags access level. Valid values are `disabled`, `private`, `enabled`.
5761
- `forking_access_level` (String) Set the forking access level. Valid values are `disabled`, `private`, `enabled`.
5862
- `http_url_to_repo` (String) URL that can be provided to `git clone` to clone the
5963
- `import_url` (String) URL the project was imported from.
64+
- `infrastructure_access_level` (String) Set the infrastructure access level. Valid values are `disabled`, `private`, `enabled`.
6065
- `issues_access_level` (String) Set the issues access level. Valid values are `disabled`, `private`, `enabled`.
6166
- `issues_enabled` (Boolean) Enable issue tracking for the project.
6267
- `lfs_enabled` (Boolean) Enable LFS for the project.
@@ -65,21 +70,23 @@ data "gitlab_project" "example" {
6570
- `merge_requests_access_level` (String) Set the merge requests access level. Valid values are `disabled`, `private`, `enabled`.
6671
- `merge_requests_enabled` (Boolean) Enable merge requests for the project.
6772
- `merge_trains_enabled` (Boolean) Enable or disable merge trains.
73+
- `monitor_access_level` (String) Set the monitor access level. Valid values are `disabled`, `private`, `enabled`.
6874
- `name` (String) The name of the project.
6975
- `namespace_id` (Number) The namespace (group or user) of the project. Defaults to your user.
7076
- `operations_access_level` (String) Set the operations access level. Valid values are `disabled`, `private`, `enabled`.
7177
- `path` (String) The path of the repository.
7278
- `pipelines_enabled` (Boolean) Enable pipelines for the project.
7379
- `printing_merge_request_link_enabled` (Boolean) Show link to create/view merge request when pushing from the command line
7480
- `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))
81+
- `releases_access_level` (String) Set the releases access level. Valid values are `disabled`, `private`, `enabled`.
7582
- `remove_source_branch_after_merge` (Boolean) Enable `Delete source branch` option by default for all new merge requests
7683
- `repository_access_level` (String) Set the repository access level. Valid values are `disabled`, `private`, `enabled`.
7784
- `repository_storage` (String) Which storage shard the repository is on. (administrator only)
7885
- `request_access_enabled` (Boolean) Allow users to request member access.
7986
- `requirements_access_level` (String) Set the requirements access level. Valid values are `disabled`, `private`, `enabled`.
8087
- `resolve_outdated_diff_discussions` (Boolean) Automatically resolve merge request diffs discussions on lines changed with a push.
8188
- `restrict_user_defined_variables` (Boolean) Allow only users with the Maintainer role to pass user-defined variables when triggering a pipeline.
82-
- `runners_token` (String) Registration token to use during runner setup.
89+
- `runners_token` (String, Sensitive) Registration token to use during runner setup.
8390
- `security_and_compliance_access_level` (String) Set the security and compliance access level. Valid values are `disabled`, `private`, `enabled`.
8491
- `snippets_access_level` (String) Set the snippets access level. Valid values are `disabled`, `private`, `enabled`.
8592
- `snippets_enabled` (Boolean) Enable snippets for the project.
@@ -100,6 +107,7 @@ Read-Only:
100107
- `cadence` (String)
101108
- `enabled` (Boolean)
102109
- `keep_n` (Number)
110+
- `name_regex` (String)
103111
- `name_regex_delete` (String)
104112
- `name_regex_keep` (String)
105113
- `next_run_at` (String)

docs/data-sources/projects.md

+6
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,9 @@ Read-Only:
104104
- `default_branch` (String)
105105
- `description` (String)
106106
- `emails_disabled` (Boolean)
107+
- `environments_access_level` (String)
107108
- `external_authorization_classification_label` (String)
109+
- `feature_flags_access_level` (String)
108110
- `forked_from_project` (List of Object) (see [below for nested schema](#nestedobjatt--projects--forked_from_project))
109111
- `forking_access_level` (String)
110112
- `forks_count` (Number)
@@ -113,6 +115,7 @@ Read-Only:
113115
- `import_error` (String)
114116
- `import_status` (String)
115117
- `import_url` (String)
118+
- `infrastructure_access_level` (String)
116119
- `issues_access_level` (String)
117120
- `issues_enabled` (Boolean)
118121
- `jobs_enabled` (Boolean)
@@ -128,6 +131,7 @@ Read-Only:
128131
- `mirror_overwrites_diverged_branches` (Boolean)
129132
- `mirror_trigger_builds` (Boolean)
130133
- `mirror_user_id` (Number)
134+
- `monitor_access_level` (String)
131135
- `name` (String)
132136
- `name_with_namespace` (String)
133137
- `namespace` (List of Object) (see [below for nested schema](#nestedobjatt--projects--namespace))
@@ -144,6 +148,7 @@ Read-Only:
144148
- `public` (Boolean)
145149
- `public_builds` (Boolean)
146150
- `readme_url` (String)
151+
- `releases_access_level` (String)
147152
- `repository_access_level` (String)
148153
- `repository_storage` (String)
149154
- `request_access_enabled` (Boolean)
@@ -176,6 +181,7 @@ Read-Only:
176181
- `cadence` (String)
177182
- `enabled` (Boolean)
178183
- `keep_n` (Number)
184+
- `name_regex` (String)
179185
- `name_regex_delete` (String)
180186
- `name_regex_keep` (String)
181187
- `next_run_at` (String)

docs/data-sources/repository_file.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ data "gitlab_repository_file" "example" {
2828

2929
### Required
3030

31-
- `file_path` (String) The full path of the file. It must be relative to the root of the project without a leading slash `/`.
31+
- `file_path` (String) The full path of the file. It must be relative to the root of the project without a leading slash `/` or `./`.
3232
- `project` (String) The name or ID of the project.
3333
- `ref` (String) The name of branch, tag or commit.
3434

docs/resources/application.md

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "gitlab_application Resource - terraform-provider-gitlab"
4+
subcategory: ""
5+
description: |-
6+
The gitlab_application resource allows to manage the lifecycle of applications in gitlab.
7+
~> In order to use a user for a user to create an application, they must have admin priviledges at the instance level.
8+
To create an OIDC application, a scope of "openid".
9+
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/applications.html
10+
---
11+
12+
# gitlab_application (Resource)
13+
14+
The `gitlab_application` resource allows to manage the lifecycle of applications in gitlab.
15+
16+
~> In order to use a user for a user to create an application, they must have admin priviledges at the instance level.
17+
To create an OIDC application, a scope of "openid".
18+
19+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/applications.html)
20+
21+
## Example Usage
22+
23+
```terraform
24+
resource "gitlab_application" "oidc" {
25+
confidential = true
26+
scopes = ["openid"]
27+
name = "company_oidc"
28+
redirect_url = "https://mycompany.com"
29+
}
30+
```
31+
32+
<!-- schema generated by tfplugindocs -->
33+
## Schema
34+
35+
### Required
36+
37+
- `name` (String) Name of the application.
38+
- `redirect_url` (String) The URL gitlab should send the user to after authentication.
39+
- `scopes` (Set of String) Scopes of the application. Use "openid" if you plan to use this as an oidc authentication application. Valid options are: `api`, `read_api`, `read_user`, `read_repository`, `write_repository`, `read_registry`, `write_registry`, `sudo`, `admin_mode`, `openid`, `profile`, `email`.
40+
This is only populated when creating a new application. This attribute is not available for imported resources
41+
42+
### Optional
43+
44+
- `confidential` (Boolean) The application is used where the client secret can be kept confidential. Native mobile apps and Single Page Apps are considered non-confidential. Defaults to true if not supplied
45+
46+
### Read-Only
47+
48+
- `application_id` (String) Internal name of the application.
49+
- `id` (String) The ID of this Terraform resource. In the format of `<application_id>`.
50+
- `secret` (String, Sensitive) Application secret. Sensative and must be kept secret. This is only populated when creating a new application. This attribute is not available for imported resources.
51+
52+
## Import
53+
54+
Import is supported using the following syntax:
55+
56+
```shell
57+
# Gitlab applications can be imported with their id, e.g.
58+
terraform import gitlab_application.example "1"
59+
60+
# NOTE: the secret and scopes cannot be imported
61+
```

docs/resources/branch.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,6 @@ Read-Only:
7373
Import is supported using the following syntax:
7474

7575
```shell
76-
# Gitlab protected branches can be imported with a key composed of `<project_id>:<branch_name>`, e.g.
76+
# Gitlab branches can be imported with a key composed of `<project_id>:<branch_name>`, e.g.
7777
terraform import gitlab_branch.example "12345:develop"
7878
```

docs/resources/personal_access_token.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ resource "gitlab_project_variable" "example" {
4040
### Required
4141

4242
- `name` (String) The name of the personal access token.
43-
- `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`.
43+
- `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`.
4444
- `user_id` (Number) The id of the user.
4545

4646
### Optional

0 commit comments

Comments
 (0)