Skip to content

Commit 2a38c37

Browse files
gitlab-terraform-provider-botgitlab-terraform-provider-bot
committed
Update docs for v18.6.1 release
1 parent 12f38c4 commit 2a38c37

File tree

189 files changed

+16397
-0
lines changed

Some content is hidden

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

189 files changed

+16397
-0
lines changed

‎CHANGELOG.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
## 18.6.1 (2025-11-21)
2+
3+
### BUG FIXES (1 change)
4+
5+
- docs: [Clear old version of GitHub docs before copying new version in](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/c483add6ead058010c38d832d52039ca20f1da8f) by @heidi.berry ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2786))
6+
17
## 18.6.0 (2025-11-20)
28

39
### FEATURES (2 changes)

‎docs/data-sources/application.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
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/api/applications/
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/api/applications/)
15+
16+
## Example Usage
17+
18+
```terraform
19+
data "gitlab_application" "oidc" {
20+
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.

‎docs/data-sources/artifact_file.md‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "gitlab_artifact_file Data Source - terraform-provider-gitlab"
4+
subcategory: ""
5+
description: |-
6+
The gitlab_artifact_file data source allows downloading a single artifact file from a specific job in the latest successful pipeline for a given reference (branch, tag, or commit).
7+
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/job_artifacts.html#download-a-single-artifact-file-from-specific-tag-or-branch
8+
---
9+
10+
# gitlab_artifact_file (Data Source)
11+
12+
The `gitlab_artifact_file` data source allows downloading a single artifact file from a specific job in the latest successful pipeline for a given reference (branch, tag, or commit).
13+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/job_artifacts.html#download-a-single-artifact-file-from-specific-tag-or-branch)
14+
15+
## Example Usage
16+
17+
```terraform
18+
# Download a text artifact file from the latest successful pipeline
19+
data "gitlab_artifact_file" "config" {
20+
project = "namespace/myproject"
21+
job = "build-job"
22+
ref = "main"
23+
artifact_path = "config/settings.json"
24+
}
25+
26+
# Use the artifact content
27+
output "config_content" {
28+
value = data.gitlab_artifact_file.config.content
29+
}
30+
31+
# Download a binary artifact file using base64 encoding
32+
data "gitlab_artifact_file" "binary" {
33+
project = "namespace/myproject"
34+
job = "build-job"
35+
ref = "v1.0.0"
36+
artifact_path = "dist/app.zip"
37+
}
38+
39+
output "binary_content_base64" {
40+
value = data.gitlab_artifact_file.binary.content_base64
41+
}
42+
43+
# Download artifact from a specific tag
44+
data "gitlab_artifact_file" "release" {
45+
project = "12345"
46+
job = "release-job"
47+
ref = "v2.1.0"
48+
artifact_path = "release-notes.txt"
49+
}
50+
51+
# Download a larger artifact with custom size limit
52+
data "gitlab_artifact_file" "large_artifact" {
53+
project = "namespace/myproject"
54+
job = "build-job"
55+
ref = "main"
56+
artifact_path = "dist/large-file.zip"
57+
max_size_bytes = 20971520 # 20MB
58+
}
59+
```
60+
61+
<!-- schema generated by tfplugindocs -->
62+
## Schema
63+
64+
### Required
65+
66+
- `artifact_path` (String) Path to the artifact file within the job's artifacts archive. This path is relative to the archive contents (not the local filesystem). Ensure each `gitlab_artifact_file` data source in your configuration uses a unique artifact_path to avoid ambiguity.
67+
- `job` (String) The name of the job.
68+
- `project` (String) The ID or URL-encoded path of the project.
69+
- `ref` (String) The name of the branch, tag, or commit SHA.
70+
71+
### Optional
72+
73+
- `max_size_bytes` (Number) Maximum bytes to read from the artifact. Defaults to 10MB (10485760 bytes).
74+
75+
### Read-Only
76+
77+
- `content` (String) The content of the artifact file as a UTF-8 string. Use `content_base64` for binary files.
78+
- `content_base64` (String) The content of the artifact file as a base64-encoded string. Useful for binary files.
79+
- `id` (String) The ID of this datasource. In the format `<project>:<ref>:<job>:<artifact_path>`.

‎docs/data-sources/branch.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "gitlab_branch Data Source - terraform-provider-gitlab"
4+
subcategory: ""
5+
description: |-
6+
The gitlab_branch data source allows details of a repository branch to be retrieved by its name and project.
7+
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/branches/#get-single-repository-branch
8+
---
9+
10+
# gitlab_branch (Data Source)
11+
12+
The `gitlab_branch` data source allows details of a repository branch to be retrieved by its name and project.
13+
14+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/branches/#get-single-repository-branch)
15+
16+
## Example Usage
17+
18+
```terraform
19+
# By project ID
20+
data "gitlab_branch" "foo" {
21+
name = "example"
22+
project = "12345"
23+
}
24+
25+
# By project full path
26+
data "gitlab_branch" "foo" {
27+
name = "example"
28+
project = "foo/bar"
29+
}
30+
```
31+
32+
<!-- schema generated by tfplugindocs -->
33+
## Schema
34+
35+
### Required
36+
37+
- `name` (String) The name of the branch.
38+
- `project` (String) The full path or id of the project.
39+
40+
### Read-Only
41+
42+
- `can_push` (Boolean) Bool, true if you can push to the branch.
43+
- `commit` (Attributes Set) The commit associated with the branch ref. (see [below for nested schema](#nestedatt--commit))
44+
- `default` (Boolean) Bool, true if branch is the default branch for the project.
45+
- `developer_can_merge` (Boolean) Bool, true if developer level access allows to merge branch.
46+
- `developer_can_push` (Boolean) Bool, true if developer level access allows git push.
47+
- `id` (String) The ID of this datasource. In the format `<project:name>`.
48+
- `merged` (Boolean) Bool, true if the branch has been merged into its parent.
49+
- `protected` (Boolean) Bool, true if branch has branch protection.
50+
- `web_url` (String) The url of the created branch (https.)
51+
52+
<a id="nestedatt--commit"></a>
53+
### Nested Schema for `commit`
54+
55+
Read-Only:
56+
57+
- `author_email` (String) The email of the author.
58+
- `author_name` (String) The name of the author.
59+
- `authored_date` (String) The date which the commit was authored (format: yyyy-MM-ddTHH:mm:ssZ).
60+
- `committed_date` (String) The date at which the commit was pushed (format: yyyy-MM-ddTHH:mm:ssZ).
61+
- `committer_email` (String) The email of the user that committed.
62+
- `committer_name` (String) The name of the user that committed.
63+
- `id` (String) The unique id assigned to the commit by Gitlab.
64+
- `message` (String) The commit message
65+
- `parent_ids` (Set of String) The id of the parents of the commit
66+
- `short_id` (String) The short id assigned to the commit by Gitlab.
67+
- `title` (String) The title of the commit

‎docs/data-sources/cluster_agent.md‎

Lines changed: 38 additions & 0 deletions
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_cluster_agent Data Source - terraform-provider-gitlab"
4+
subcategory: ""
5+
description: |-
6+
The gitlab_cluster_agent data source retrieves details about a GitLab Agent for Kubernetes.
7+
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/cluster_agents/
8+
---
9+
10+
# gitlab_cluster_agent (Data Source)
11+
12+
The `gitlab_cluster_agent` data source retrieves details about a GitLab Agent for Kubernetes.
13+
14+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/cluster_agents/)
15+
16+
## Example Usage
17+
18+
```terraform
19+
data "gitlab_cluster_agent" "example" {
20+
project = "12345"
21+
agent_id = 1
22+
}
23+
```
24+
25+
<!-- schema generated by tfplugindocs -->
26+
## Schema
27+
28+
### Required
29+
30+
- `agent_id` (Number) The ID of the agent.
31+
- `project` (String) ID or full path of the project maintained by the authenticated user.
32+
33+
### Read-Only
34+
35+
- `created_at` (String) The ISO8601 datetime when the agent was created.
36+
- `created_by_user_id` (Number) The ID of the user who created the agent.
37+
- `id` (String) The ID of this data source. In the format <project:agent_id>
38+
- `name` (String) The Name of the agent.

‎docs/data-sources/cluster_agents.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "gitlab_cluster_agents Data Source - terraform-provider-gitlab"
4+
subcategory: ""
5+
description: |-
6+
The gitlab_cluster_agents data source retrieves details of GitLab Agents for Kubernetes in a project.
7+
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/cluster_agents/
8+
---
9+
10+
# gitlab_cluster_agents (Data Source)
11+
12+
The `gitlab_cluster_agents` data source retrieves details of GitLab Agents for Kubernetes in a project.
13+
14+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/cluster_agents/)
15+
16+
## Example Usage
17+
18+
```terraform
19+
data "gitlab_cluster_agents" "agents" {
20+
project = "12345"
21+
}
22+
```
23+
24+
<!-- schema generated by tfplugindocs -->
25+
## Schema
26+
27+
### Required
28+
29+
- `project` (String) ID or full path of the project maintained by the authenticated user.
30+
31+
### Read-Only
32+
33+
- `cluster_agents` (Attributes List) List of the registered agents. (see [below for nested schema](#nestedatt--cluster_agents))
34+
- `id` (String) The ID of this data source. In the format <project>
35+
36+
<a id="nestedatt--cluster_agents"></a>
37+
### Nested Schema for `cluster_agents`
38+
39+
Read-Only:
40+
41+
- `agent_id` (Number) The ID of the agent.
42+
- `created_at` (String) The ISO8601 datetime when the agent was created.
43+
- `created_by_user_id` (Number) The ID of the user who created the agent.
44+
- `name` (String) The Name of the agent.
45+
- `project` (String) ID or full path of the project maintained by the authenticated user.

‎docs/data-sources/compliance_framework.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "gitlab_compliance_framework Data Source - terraform-provider-gitlab"
4+
subcategory: ""
5+
description: |-
6+
The gitlab_compliance_framework data source allows details of a compliance framework to be retrieved by its name and the namespace it belongs to.
7+
Upstream API: GitLab GraphQL API docs https://docs.gitlab.com/api/graphql/reference/#querynamespace
8+
---
9+
10+
# gitlab_compliance_framework (Data Source)
11+
12+
The `gitlab_compliance_framework` data source allows details of a compliance framework to be retrieved by its name and the namespace it belongs to.
13+
14+
**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/api/graphql/reference/#querynamespace)
15+
16+
## Example Usage
17+
18+
```terraform
19+
data "gitlab_compliance_framework" "example" {
20+
namespace_path = "top-level-group"
21+
name = "HIPAA"
22+
}
23+
```
24+
25+
<!-- schema generated by tfplugindocs -->
26+
## Schema
27+
28+
### Required
29+
30+
- `name` (String) Name for the compliance framework.
31+
- `namespace_path` (String) Full path of the namespace to where the compliance framework is.
32+
33+
### Read-Only
34+
35+
- `color` (String) Color representation of the compliance framework in hex format. e.g. #FCA121.
36+
- `default` (Boolean) Is the compliance framework the default framework for the group.
37+
- `description` (String) Description for the compliance framework.
38+
- `framework_id` (String) Globally unique ID of the compliance framework.
39+
- `id` (String) The ID of this Terraform resource. In the format of `<namespace_path>:<framework_id>`.
40+
- `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`. Format: `path/file.y[a]ml@group-name/project-name` **Note**: Ultimate license required.

‎docs/data-sources/current_user.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "gitlab_current_user Data Source - terraform-provider-gitlab"
4+
subcategory: ""
5+
description: |-
6+
The gitlab_current_user data source allows details of the current user (determined by token provider attribute) to be retrieved.
7+
Upstream API: GitLab GraphQL API docs https://docs.gitlab.com/api/graphql/reference/index/#querycurrentuser
8+
---
9+
10+
# gitlab_current_user (Data Source)
11+
12+
The `gitlab_current_user` data source allows details of the current user (determined by `token` provider attribute) to be retrieved.
13+
14+
**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/api/graphql/reference/index/#querycurrentuser)
15+
16+
## Example Usage
17+
18+
```terraform
19+
data "gitlab_current_user" "example" {}
20+
```
21+
22+
<!-- schema generated by tfplugindocs -->
23+
## Schema
24+
25+
### Read-Only
26+
27+
- `bot` (Boolean) Indicates if the user is a bot.
28+
- `global_id` (String) Global ID of the user. This is in the form of a GraphQL globally unique ID.
29+
- `global_namespace_id` (String) Personal namespace of the user. This is in the form of a GraphQL globally unique ID.
30+
- `group_count` (Number) Group count for the user.
31+
- `id` (String) ID of the user.
32+
- `name` (String) Human-readable name of the user. Returns **** if the user is a project bot and the requester does not have permission to view the project.
33+
- `namespace_id` (String) Personal namespace of the user.
34+
- `public_email` (String) User's public email.
35+
- `username` (String) Username of the user. Unique within this instance of GitLab.

0 commit comments

Comments
 (0)