Skip to content

Latest commit

 

History

History
124 lines (93 loc) · 3.65 KB

project_issue_board.md

File metadata and controls

124 lines (93 loc) · 3.65 KB
page_title subcategory description
gitlab_project_issue_board Resource - terraform-provider-gitlab
The gitlab_project_issue_board resource allows to manage the lifecycle of a Project Issue Board. ~> NOTE: If the board lists are changed all lists will be recreated. Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/boards.html

gitlab_project_issue_board (Resource)

The gitlab_project_issue_board resource allows to manage the lifecycle of a Project Issue Board.

~> NOTE: If the board lists are changed all lists will be recreated.

Upstream API: GitLab REST API docs

Example Usage

resource "gitlab_project" "example" {
  name             = "example project"
  description      = "Lorem Ipsum"
  visibility_level = "public"
}

resource "gitlab_user" "example" {
  name     = "example"
  username = "example"
  email    = "example@example.com"
  password = "example1$$$"
}

resource "gitlab_project_membership" "example" {
  project_id   = gitlab_project.example.id
  user_id      = gitlab_user.example.id
  access_level = "developer"
}

resource "gitlab_project_milestone" "example" {
  project = gitlab_project.example.id
  title   = "m1"
}

resource "gitlab_project_issue_board" "this" {
  project = gitlab_project.example.id
  name    = "Test Issue Board"

  lists {
    assignee_id = gitlab_user.example.id
  }

  lists {
    milestone_id = gitlab_project_milestone.example.milestone_id
  }

  depends_on = [
    gitlab_project_membership.example
  ]
}

resource "gitlab_project_issue_board" "list_syntax" {
  project = gitlab_project.example.id
  name    = "Test Issue Board with list syntax"

  lists = [
    {
      assignee_id = gitlab_user.example.id
    },
    {
      milestone_id = gitlab_project_milestone.example.milestone_id
    }
  ]

  depends_on = [
    gitlab_project_membership.example
  ]
}

Schema

Required

  • name (String) The name of the board.
  • project (String) The ID or full path of the project maintained by the authenticated user.

Optional

  • assignee_id (Number) The assignee the board should be scoped to. Requires a GitLab EE license.
  • labels (Set of String) The list of label names which the board should be scoped to. Requires a GitLab EE license.
  • lists (Block List) The list of issue board lists (see below for nested schema)
  • milestone_id (Number) The milestone the board should be scoped to. Requires a GitLab EE license.
  • weight (Number) The weight range from 0 to 9, to which the board should be scoped to. Requires a GitLab EE license.

Read-Only

  • id (String) The ID of this resource.

Nested Schema for lists

Optional:

  • assignee_id (Number) The ID of the assignee the list should be scoped to. Requires a GitLab EE license.
  • iteration_id (Number) The ID of the iteration the list should be scoped to. Requires a GitLab EE license.
  • label_id (Number) The ID of the label the list should be scoped to. Requires a GitLab EE license.
  • milestone_id (Number) The ID of the milestone the list should be scoped to. Requires a GitLab EE license.

Read-Only:

  • id (Number) The ID of the list
  • position (Number) The position of the list within the board. The position for the list is based on the its position in the lists array.

Import

Import is supported using the following syntax:

# You can import this resource with an id made up of `{project-id}:{issue-board-id}`, e.g.
terraform import gitlab_project_issue_board.kanban 42:1