Skip to content

Commit

Permalink
Update docs for v17.9.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
gitlab-terraform-provider-bot committed Feb 20, 2025
1 parent 2f662cd commit d1cad48
Show file tree
Hide file tree
Showing 160 changed files with 814 additions and 496 deletions.
38 changes: 38 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,41 @@
## 17.9.0 (2025-02-20)

This release was tested against GitLab 17.9, 17.8, and 17.7 for both CE and EE

### KNOWN ISSUES (1 change)

- resource/gitlab_integration_jira: `comment_on_event_enabled` isn't persisting properly to the underlying integration. This appears to be an upstream issue, but can be tracked [here](https://gitlab.com/gitlab-org/gitlab/-/issues/520330). This will cause an immediate `plan` after `apply` if that attribute is included in the config. Removing the attribute from the config temporarily will allow it to be modified via the UI until this issue is resolved.

### FEATURES (3 changes)

- resource/gitlab_project_release: [Add a new resource for managing project releases](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/93b023aa30ef1038eb8c153f601678aa0fc4f7b1) by @heidi.berry ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2277))
- resource/gitlab_wiki_page: [Add a new wiki page resource](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/bb77788364f15abd4140766ef6a0bb97011d9839) by @nursultanryskulov1 ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2219))
- datasource/gitlab_instance_service_account: [Add a new instance service account datasource](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/5630deca25de2f741841ed2b9a94a4d163bf06c1) by @ipsavitsky234 ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2271))

### IMPROVEMENTS (8 changes)

- resource/gitlab_group_variable: [Added support for `hidden` variables](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/524765fe53d36fc11ae24bb9dc08c2bbf6f2a077) by @yogeshlonkar ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2237))
- resource/gitlab_member_role: [Align custom permissions to current API options (adds 5 new permissions to the provider)](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/7ce852f435aba9a64025047835003f5da5771386) by @PatrickRice ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2280))
- resource/gitlab_project_job_token_scope: [Add support for `groupd_id`](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/cd6c9e62237794406e1595d127ae7ed5c0dcbc08) by @dc-tec ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2290))
- resource/gitlab_project_hook: [Add support for `resource_access_token_events`](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/7a124e9ca25204232f5e2288e3f9c3686fcd2c69) by @dc-tec ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2292))
- resource/gitlab_project_membership: [Add custom role support to project membership via `member_role_id`](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/e91dc20a440b699e6ac677397fd398b36f972746) by @mness ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2272))
- resource/gitlab_instance_service_account: [Add `gitlab_instance_service_account` documentation](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/136bfbe8e2147f5a0ca97eb12a445013020de64a) by @ipsavitsky234 ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2270))
- [Update Documentation Links to align to new API documentation Launch](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/8a550b86f57da691125bc1f1669e43a255912391) by @Taucher2003 ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2328))
- [Update the CONTRIBUTING.md docs to fix links and provide better development instructions](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/74dfef50d5c9118f1e673786d69ee9a5027e066e) by @jtymes ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2274))

### BUG FIXES (5 changes)

- resource/gitlab_integration_jira: [Fix issue where `comment_on_event_enabled` causes a plan after apply when not defined in the config](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/7ced3cb22e9d3d2262e6133bc6024e9e8638c658) by @PatrickRice ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2332))
- resource/gitlab_group_service_account_access_token: [Fix an error when deleting an expired service account access token using a non-admin user](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/026c696d905c03426545398eba6cacf7621aaa92) by @heidi.berry ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2287))
- resource/gitlab_group_service_account_access_token: [Fix an error when rotating a service account access token that would cause an invalid `id` attribute](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/537004cef0a1c54aa040f7779e98eddfa5a27e44) by @PatrickRice ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2282))
- resource/gitlab_value_stream_analytics: [Fix an error with label validation, fixed typo in one event name](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/8a0918901c28ae809ad3943d302df70e0ed58054) by @calee1 ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2289))
- datasource/gitlab_group_service_account: [Set name and username in group service accounts as read-only to align with API](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/698ffdcaaec2a797edc53299134fa98aeee4190e) by @ipsavitsky234 ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2286))

### Maintenance (2 changes)

- [Remove documentation related to very old GitLab versions](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/9ec88d9245d220438234920ff91458235a152f73) by @heidi.berry ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2311))
- [Update Documentation to include explicit version support policies](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/39f048e4d796574e5e53a809c4c1148d5554fd2f) by @heidi.berry ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2312))

## 17.8.0 (2025-01-16)

This release was tested against GitLab 17.8, 17.7, and 17.6 for both CE and EE
Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/application.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ page_title: "gitlab_application Data Source - terraform-provider-gitlab"
subcategory: ""
description: |-
The gitlab_application data source retrieves information about a gitlab application.
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/applications.html
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/applications/
---

# gitlab_application (Data Source)

The `gitlab_application` data source retrieves information about a gitlab application.

**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/applications.html)
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/applications/)

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/branch.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ page_title: "gitlab_branch Data Source - terraform-provider-gitlab"
subcategory: ""
description: |-
The gitlab_branch data source allows details of a repository branch to be retrieved by its name and project.
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/branches.html#get-single-repository-branch
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/branches/#get-single-repository-branch
---

# gitlab_branch (Data Source)

The `gitlab_branch` data source allows details of a repository branch to be retrieved by its name and project.

**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/branches.html#get-single-repository-branch)
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/branches/#get-single-repository-branch)

## Example Usage

Expand Down
7 changes: 2 additions & 5 deletions docs/data-sources/cluster_agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,14 @@ page_title: "gitlab_cluster_agent Data Source - terraform-provider-gitlab"
subcategory: ""
description: |-
The gitlab_cluster_agent data source allows to retrieve details about a GitLab Agent for Kubernetes.
-> Requires at least GitLab 14.10
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/cluster_agents.html
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/cluster_agents/
---

# gitlab_cluster_agent (Data Source)

The `gitlab_cluster_agent` data source allows to retrieve details about a GitLab Agent for Kubernetes.

-> Requires at least GitLab 14.10

**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/cluster_agents.html)
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/cluster_agents/)

## Example Usage

Expand Down
7 changes: 2 additions & 5 deletions docs/data-sources/cluster_agents.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,14 @@ page_title: "gitlab_cluster_agents Data Source - terraform-provider-gitlab"
subcategory: ""
description: |-
The gitlab_cluster_agents data source allows details of GitLab Agents for Kubernetes in a project.
-> Requires at least GitLab 14.10
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/cluster_agents.html
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/cluster_agents/
---

# gitlab_cluster_agents (Data Source)

The `gitlab_cluster_agents` data source allows details of GitLab Agents for Kubernetes in a project.

-> Requires at least GitLab 14.10

**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/cluster_agents.html)
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/cluster_agents/)

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/compliance_framework.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ page_title: "gitlab_compliance_framework Data Source - terraform-provider-gitlab
subcategory: ""
description: |-
The gitlab_compliance_framework data source allows details of a compliance framework to be retrieved by its name and the namespace it belongs to.
Upstream API: GitLab GraphQL API docs https://docs.gitlab.com/ee/api/graphql/reference/#querynamespace
Upstream API: GitLab GraphQL API docs https://docs.gitlab.com/api/graphql/reference/#querynamespace
---

# gitlab_compliance_framework (Data Source)

The `gitlab_compliance_framework` data source allows details of a compliance framework to be retrieved by its name and the namespace it belongs to.

**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/ee/api/graphql/reference/#querynamespace)
**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/api/graphql/reference/#querynamespace)

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/current_user.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ page_title: "gitlab_current_user Data Source - terraform-provider-gitlab"
subcategory: ""
description: |-
The gitlab_current_user data source allows details of the current user (determined by token provider attribute) to be retrieved.
Upstream API: GitLab GraphQL API docs https://docs.gitlab.com/ee/api/graphql/reference/index.html#querycurrentuser
Upstream API: GitLab GraphQL API docs https://docs.gitlab.com/api/graphql/reference/index/#querycurrentuser
---

# gitlab_current_user (Data Source)

The `gitlab_current_user` data source allows details of the current user (determined by `token` provider attribute) to be retrieved.

**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/ee/api/graphql/reference/index.html#querycurrentuser)
**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/api/graphql/reference/index/#querycurrentuser)

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/group.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ page_title: "gitlab_group Data Source - terraform-provider-gitlab"
subcategory: ""
description: |-
The gitlab_group data source allows details of a group to be retrieved by its id or full path.
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/groups.html#details-of-a-group
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/groups/#details-of-a-group
---

# gitlab_group (Data Source)

The `gitlab_group` data source allows details of a group to be retrieved by its id or full path.

**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/groups.html#details-of-a-group)
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/groups/#details-of-a-group)

## Example Usage

Expand Down
6 changes: 3 additions & 3 deletions docs/data-sources/group_billable_member_memberships.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: |-
-> You must be an administrator!
~> When using the email attribute, an exact match is not guaranteed. The most related match will be returned. Starting with GitLab 16.6,
the most related match will prioritize an exact match if one is available.
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/members.html#list-memberships-for-a-billable-member-of-a-group
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/members/#list-memberships-for-a-billable-member-of-a-group
---

# gitlab_group_billable_member_memberships (Data Source)
Expand All @@ -19,7 +19,7 @@ The `gitlab_group_billable_member_memberships` data source allows (sub)group- an
~> When using the `email` attribute, an exact match is not guaranteed. The most related match will be returned. Starting with GitLab 16.6,
the most related match will prioritize an exact match if one is available.

**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/members.html#list-memberships-for-a-billable-member-of-a-group)
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/members/#list-memberships-for-a-billable-member-of-a-group)

## Example Usage

Expand Down Expand Up @@ -48,7 +48,7 @@ data "gitlab_group_billable_member_memberships" "test_user_membership" {

Read-Only:

- `access_level` (String) Access-level of the member. For details see: https://docs.gitlab.com/ee/api/access_requests.html#valid-access-levels
- `access_level` (String) Access-level of the member. For details see: https://docs.gitlab.com/api/access_requests/#valid-access-levels
- `created_at` (String) Datetime when the membership was first added.
- `expires_at` (String) Date when the membership will end.
- `id` (Number) The id of the membership.
Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/group_hook.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ page_title: "gitlab_group_hook Data Source - terraform-provider-gitlab"
subcategory: ""
description: |-
The gitlab_group_hook data source allows to retrieve details about a hook in a group.
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/groups.html#get-group-hook
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/groups/#get-group-hook
---

# gitlab_group_hook (Data Source)

The `gitlab_group_hook` data source allows to retrieve details about a hook in a group.

**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/groups.html#get-group-hook)
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/groups/#get-group-hook)

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/group_hooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ page_title: "gitlab_group_hooks Data Source - terraform-provider-gitlab"
subcategory: ""
description: |-
The gitlab_group_hooks data source allows to retrieve details about hooks in a group.
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/groups.html#list-group-hooks
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/groups/#list-group-hooks
---

# gitlab_group_hooks (Data Source)

The `gitlab_group_hooks` data source allows to retrieve details about hooks in a group.

**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/groups.html#list-group-hooks)
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/groups/#list-group-hooks)

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/group_ids.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ page_title: "gitlab_group_ids Data Source - terraform-provider-gitlab"
subcategory: ""
description: |-
The gitlab_group_ids data source identification information for a given group, allowing a user to translate a full path or ID into the GraphQL ID of the group.
Upstream API: GitLab GraphQL API docs https://docs.gitlab.com/ee/api/graphql/reference/#querygroup
Upstream API: GitLab GraphQL API docs https://docs.gitlab.com/api/graphql/reference/#querygroup
---

# gitlab_group_ids (Data Source)

The `gitlab_group_ids` data source identification information for a given group, allowing a user to translate a full path or ID into the GraphQL ID of the group.

**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/ee/api/graphql/reference/#querygroup)
**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/api/graphql/reference/#querygroup)

## Example Usage

Expand Down
24 changes: 12 additions & 12 deletions docs/data-sources/group_membership.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ page_title: "gitlab_group_membership Data Source - terraform-provider-gitlab"
subcategory: ""
description: |-
The gitlab_group_membership data source allows to list and filter all members of a group specified by either its id or full path.
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/members.html#list-all-members-of-a-group-or-project
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/members/#list-all-members-of-a-group-or-project
---

# gitlab_group_membership (Data Source)

The `gitlab_group_membership` data source allows to list and filter all members of a group specified by either its id or full path.

**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/members.html#list-all-members-of-a-group-or-project)
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/members/#list-all-members-of-a-group-or-project)

## Example Usage

Expand Down Expand Up @@ -39,19 +39,19 @@ data "gitlab_group_membership" "example" {

### Read-Only

- `id` (String) The ID of this resource.
- `members` (List of Object) The list of group members. (see [below for nested schema](#nestedatt--members))
- `id` (String) The ID of the group membership. In the format of `<group-id:access-level>`.
- `members` (Attributes List) The list of group members. (see [below for nested schema](#nestedatt--members))

<a id="nestedatt--members"></a>
### Nested Schema for `members`

Read-Only:

- `access_level` (String)
- `avatar_url` (String)
- `expires_at` (String)
- `id` (Number)
- `name` (String)
- `state` (String)
- `username` (String)
- `web_url` (String)
- `access_level` (String) The level of access to the group.
- `avatar_url` (String) The avatar URL of the user.
- `expires_at` (String) Expiration date for the group membership.
- `id` (Number) The unique id assigned to the user by the gitlab server.
- `name` (String) The name of the user.
- `state` (String) Whether the user is active or blocked.
- `username` (String) The username of the user.
- `web_url` (String) User's website URL.
4 changes: 2 additions & 2 deletions docs/data-sources/group_provisioned_users.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ page_title: "gitlab_group_provisioned_users Data Source - terraform-provider-git
subcategory: ""
description: |-
The gitlab_group_provisioned_users data source allows details of the provisioned users of a given group.
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/groups.html#list-provisioned-users
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/groups/#list-provisioned-users
---

# gitlab_group_provisioned_users (Data Source)

The `gitlab_group_provisioned_users` data source allows details of the provisioned users of a given group.

**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/groups.html#list-provisioned-users)
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/groups/#list-provisioned-users)



Expand Down
Loading

0 comments on commit d1cad48

Please sign in to comment.