Skip to content

Commit b12ff81

Browse files
gitlab-terraform-provider-botgitlab-terraform-provider-bot
committed
Update docs for v18.9.0 release
1 parent 5e3cb37 commit b12ff81

76 files changed

Lines changed: 622 additions & 297 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎CHANGELOG.md‎

Lines changed: 52 additions & 24 deletions
Large diffs are not rendered by default.

‎docs/data-sources/project_branches.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@ data "gitlab_project_branches" "example" {
3232

3333
- `project` (String) ID or URL-encoded path of the project owned by the authenticated user.
3434

35+
### Optional
36+
37+
- `regex` (String) Regex pattern to filter the returned branches by name.
38+
- `search` (String) A search string to filter branches by name.
39+
3540
### Read-Only
3641

3742
- `branches` (Attributes List) The list of branches of the project, as defined below. (see [below for nested schema](#nestedatt--branches))

‎docs/data-sources/project_hook.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,12 @@ data "gitlab_project_hook" "example" {
3636

3737
### Read-Only
3838

39+
- `branch_filter_strategy` (String) Filter push events by branch.
3940
- `confidential_issues_events` (Boolean) Invoke the hook for confidential issues events.
4041
- `confidential_note_events` (Boolean) Invoke the hook for confidential notes events.
4142
- `custom_webhook_template` (String) Set a custom webhook template.
4243
- `deployment_events` (Boolean) Invoke the hook for deployment events.
44+
- `emoji_events` (Boolean) Invoke the hook for emoji events.
4345
- `enable_ssl_verification` (Boolean) Enable ssl verification when invoking the hook.
4446
- `id` (String) The ID of this datasource. In the format `<project>:<hook-id>`.
4547
- `issues_events` (Boolean) Invoke the hook for issues events.

‎docs/data-sources/project_hooks.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,12 @@ data "gitlab_project_hooks" "examples" {
4242

4343
Read-Only:
4444

45+
- `branch_filter_strategy` (String) Filter push events by branch.
4546
- `confidential_issues_events` (Boolean) Invoke the hook for confidential issues events.
4647
- `confidential_note_events` (Boolean) Invoke the hook for confidential notes events.
4748
- `custom_webhook_template` (String) Set a custom webhook template.
4849
- `deployment_events` (Boolean) Invoke the hook for deployment events.
50+
- `emoji_events` (Boolean) Invoke the hook for emoji events.
4951
- `enable_ssl_verification` (Boolean) Enable ssl verification when invoking the hook.
5052
- `hook_id` (Number) The id of the project hook.
5153
- `issues_events` (Boolean) Invoke the hook for issues events.

‎docs/data-sources/project_label.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "gitlab_project_label Data Source - terraform-provider-gitlab"
4+
subcategory: ""
5+
description: |-
6+
The gitlab_project_label data source retrieves details about a project label.
7+
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/labels/
8+
---
9+
10+
# gitlab_project_label (Data Source)
11+
12+
The `gitlab_project_label` data source retrieves details about a project label.
13+
14+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/labels/)
15+
16+
## Example Usage
17+
18+
```terraform
19+
# Retrieve a project label by its ID
20+
data "gitlab_project_label" "example" {
21+
project = "385"
22+
label_id = 24
23+
}
24+
25+
# Retrieve using project path
26+
data "gitlab_project_label" "by_path" {
27+
project = "group/project"
28+
label_id = 25
29+
}
30+
```
31+
32+
<!-- schema generated by tfplugindocs -->
33+
## Schema
34+
35+
### Required
36+
37+
- `label_id` (Number) The ID of the label.
38+
- `project` (String) The ID or URL-encoded path of the project.
39+
40+
### Read-Only
41+
42+
- `closed_issues_count` (Number) The number of closed issues with this label.
43+
- `color` (String) The color of the label given in 6-digit hex notation with leading '#' sign.
44+
- `description` (String) The description of the label.
45+
- `id` (String) The ID of the label in the format `project:label_id`.
46+
- `is_project_label` (Boolean) Whether the label is a project label.
47+
- `name` (String) The name of the label.
48+
- `open_issues_count` (Number) The number of open issues with this label.
49+
- `open_merge_requests_count` (Number) The number of open merge requests with this label.
50+
- `priority` (Number) The priority of the label. Null if no priority is set.
51+
- `subscribed` (Boolean) Whether the authenticated user is subscribed to the label.
52+
- `text_color` (String) The text color of the label given in 6-digit hex notation with leading '#' sign.

‎docs/data-sources/project_labels.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "gitlab_project_labels Data Source - terraform-provider-gitlab"
4+
subcategory: ""
5+
description: |-
6+
The gitlab_project_labels data source retrieves a list of labels for a project.
7+
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/labels/
8+
---
9+
10+
# gitlab_project_labels (Data Source)
11+
12+
The `gitlab_project_labels` data source retrieves a list of labels for a project.
13+
14+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/labels/)
15+
16+
## Example Usage
17+
18+
```terraform
19+
data "gitlab_project_labels" "example" {
20+
project = "385"
21+
}
22+
```
23+
24+
<!-- schema generated by tfplugindocs -->
25+
## Schema
26+
27+
### Required
28+
29+
- `project` (String) The ID or URL-encoded path of the project.
30+
31+
### Read-Only
32+
33+
- `id` (String) The ID of this data source.
34+
- `labels` (Attributes List) The list of labels in the project. (see [below for nested schema](#nestedatt--labels))
35+
36+
<a id="nestedatt--labels"></a>
37+
### Nested Schema for `labels`
38+
39+
Read-Only:
40+
41+
- `closed_issues_count` (Number) The number of closed issues with this label.
42+
- `color` (String) The color of the label given in 6-digit hex notation with leading '#' sign.
43+
- `description` (String) The description of the label.
44+
- `id` (Number) The ID of the label.
45+
- `is_project_label` (Boolean) Whether the label is a project label.
46+
- `name` (String) The name of the label.
47+
- `open_issues_count` (Number) The number of open issues with this label.
48+
- `open_merge_requests_count` (Number) The number of open merge requests with this label.
49+
- `priority` (Number) The priority of the label. Null if no priority is set.
50+
- `subscribed` (Boolean) Whether the authenticated user is subscribed to the label.
51+
- `text_color` (String) The text color of the label given in 6-digit hex notation with leading '#' sign.

‎docs/data-sources/runners.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,9 @@ data "gitlab_runners" "this" {
3535
### Optional
3636

3737
- `paused` (Boolean) Filters for runners with the given paused value
38-
- `status` (String) Filters for runners with the given status. Valid Values are `online`, `offline`, `stale`, and `never_contacted`.
38+
- `status` (String) Filters for runners with the given status. Valid Values are `online`, `offline`, `stale`, `never_contacted`.
3939
- `tag_list` (Set of String) Filters for runners with all of the given tags
40-
- `type` (String) The type of runner to return. Valid values are `instance_type`, `group_type` and `project_type`
40+
- `type` (String) The type of runner to return. Valid values are `instance_type`, `group_type`, `project_type`.
4141

4242
### Read-Only
4343

0 commit comments

Comments
 (0)